README.md in rails_sso-0.2.1 vs README.md in rails_sso-0.3.0
- old
+ new
@@ -1,9 +1,12 @@
# SSO client Rails Engine
+[![Circle CI](https://circleci.com/gh/monterail/rails_sso/tree/master.svg?style=shield&circle-token=237c44548fb2c2597bcd0bc7b1dd99c81329e574)](https://circleci.com/gh/monterail/rails_sso/tree/master)
[![Dependency Status](https://gemnasium.com/monterail/rails_sso.svg)](https://gemnasium.com/monterail/rails_sso)
[![Gem Version](https://badge.fury.io/rb/rails_sso.svg)](http://badge.fury.io/rb/rails_sso)
+[![Code Climate](https://codeclimate.com/github/monterail/rails_sso/badges/gpa.svg)](https://codeclimate.com/github/monterail/rails_sso)
+[![Test Coverage](https://codeclimate.com/github/monterail/rails_sso/badges/coverage.svg)](https://codeclimate.com/github/monterail/rails_sso)
## About
*SOON*
@@ -16,15 +19,23 @@
gem 'omniauth-example'
gem 'rails_sso'
```
-Configure it:
+Install initializer and mount routes:
+```bash
+bin/rails generate rails_sso
+```
+
+Configure initializer:
+
```ruby
# conifg/initializers/sso.rb
RailsSso.configure do |config|
+ # url of entity provider
+ config.provider_url = 'https://example.com'
# name of oauth2 provider
config.provider_name = 'example'
# oauth keys for omniauth-example
config.provider_key = ENV['PROVIDER_KEY']
config.provider_secret = ENV['PROVIDER_SECRET']