README.md in opensesame-0.1.2 vs README.md in opensesame-0.2.0
- old
+ new
@@ -1,7 +1,10 @@
# OpenSesame
+[](http://travis-ci.org/rossta/opensesame)
+[](https://codeclimate.com/github/rossta/opensesame)
+
OpenSesame is a [Warden](https://github.com/hassox/warden) strategy for providing "walled garden" authentication for access to Rack-based applications via Omniauth. The intent is protect the visibility of your app from the outside world. For example, your company has internal apps and/or staging enviroments for multiple projects and you want something better than HTTP basic auth.
Enter OpenSesame. To authenticate, OpenSesame currently uses Omniauth and the Github API to require that a user is both logged in to Github and a member of the Github organization for which OpenSesame is configured.
## Usage
@@ -24,11 +27,11 @@
require 'opensesame'
OpenSesame.configure do |config|
config.enable Rails.env.staging?
- config.github ENV['GITHUB_APP_ID'], ENV['GITHUB_SECRET']
+ config.github ENV['GITHUB_APP_ID'], ENV['GITHUB_SECRET']
config.organization 'challengepost'
config.mounted_at '/opensesame'
end
```
@@ -37,5 +40,12 @@
```ruby
# Rails config/routes.rb
mount OpenSesame::Engine => OpenSesame.mount_prefix
```
+
+Place the following into your appplication_contrrollerb.rb:
+
+```ruby
+before_filter :authenticate_opensesame!
+```
+