Commit 6e2697ec authored by Andi Saurer's avatar Andi Saurer

set basic config and add readme

parent e664772e
# ShortMessage
[![Gem Version](https://badge.fury.io/rb/short_message.png)](http://badge.fury.io/rb/short_message)
## Installation
Add it to your Gemfile:
```ruby
gem 'short_message'
```
Run the following command to install it:
```console
bundle install
```
Run the generator:
```console
rails generate short_message:install
```
And run the migrations:
```console
rake db:migrate
```
## Usage
Create a message and deliver it:
```ruby
@sms = ShortMessage::Message.new(sender: "0041791234567", recipient: "0041799876543", text: "Hello World!")
@sms.deliver
```
## Customization
### Status Codes
If you need to customize the status response codes simply edit the internationalization files in config/locales
### Params
To override the params string add the code below into `config/initializers/short_message.rb`:
```ruby
ShortMessage::Message.module_eval do
private
def build_deliver_params_string
# your code here
end
def build_recharge_params_string amount
# your code here
end
end
```
= ShortMessage
This project rocks and uses MIT-LICENSE.
\ No newline at end of file
module ShortMessage
VERSION = "0.0.1"
VERSION = "1.0.0"
end
......@@ -9,12 +9,12 @@ Gem::Specification.new do |s|
s.version = ShortMessage::VERSION
s.authors = ["Andi Saurer"]
s.email = ["andreas.saurer@econ.uzh.ch"]
s.homepage = "TODO"
s.summary = "TODO: Summary of ShortMessage."
s.description = "TODO: Description of ShortMessage."
s.homepage = "https://gitlab.switch.ch/econ-engineering/short_message"
s.summary = "Send short messages to a specific SMS Gateway"
s.description = "Send short messages to a specific SMS Gateway"
s.license = "MIT"
s.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.rdoc"]
s.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.md"]
s.test_files = Dir["test/**/*"]
s.add_dependency "rails", "~> 4.2.6"
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment