README.md in omniauth-mvc-1.0.0 vs README.md in omniauth-mvc-1.0.1
- old
+ new
@@ -20,20 +20,36 @@
$ gem install omniauth-mvc
## Usage
-TODO: Write usage instructions here
+OmniAuth::Strategies::MVC is simply a Rack middleware. Read the OmniAuth docs for detailed instructions: https://github.com/intridea/omniauth.
+Here's a quick example, adding the middleware to a Rails app in config/initializers/omniauth.rb:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+ provider :mvc, ENV['MVC_KEY'], ENV['MVC_SECRET']
+end
+```
+
+[See the example Sinatra app for full examples](https://github.com/yasu/omniauth-mvc/blob/master/example/config.ru) of both the server and client-side flows.
+
+Go to the example directory and execute the following command:
+
+```
+$ rackup -p 4567
+```
+
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
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]/omniauth-mvc.
+Bug reports and pull requests are welcome on GitHub at https://github.com/yasu/omniauth-mvc.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).