Commit c700beb

mo <mo.khan@gmail.com>
2018-04-27 17:23:04
update the README. tag: v0.1.2
1 parent 1c243b8
Changed files (1)
README.md
@@ -1,38 +1,40 @@
 # Incognito
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/incognito`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Send and Receive SMS messages from your terminal.
 
 ## Installation
 
-Add this line to your application's Gemfile:
 
-```ruby
-gem 'incognito'
-```
+Install it from https://rubygems.org:
 
-And then execute:
+    $ gem install incognito
 
-    $ bundle
+Create an account at [twilio](https://www.twilio.com)
 
-Or install it yourself as:
+Configure the following settings in your shell profile.
 
-    $ gem install incognito
+    $ export TWILIO_SID="MYSID"
+    $ export TWILIO_TOKEN="MYTOKEN"
+    $ export TWILIO_NUMBER="MYNUMBER"
 
 ## Usage
 
-TODO: Write usage instructions here
+To see the help:
+
+    $ incognito help
+
+To send an SMS to a specific phone #:
+
+    $ incognito sms message +18005557777 "hello stranger!"
 
-## Development
+To send and receive SMS:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+    $ incognito sms server # follow the onscreen instructions
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/incognito.
+Bug reports and pull requests are welcome on GitHub at https://github.com/mokhan/incognito.
 
 ## License