README.md in omniauth-pam-1.2.0 vs README.md in omniauth-pam-1.2.1
- old
+ new
@@ -1,30 +1,45 @@
-# OmniAuth PAM
+# omniauth-pam
-Allows you to authenticate against PAM using OmniAuth.
+An OmniAuth strategy to allow you to authentication against Pluggable Authentication
+Modules (PAM).
+## Installation
+
+Add `omniauth-pam` to your Gemfile, or:
+
+```
+gem install omniauth-pam
+```
+
## Usage
- use OmniAuth:Strategies::PAM
+It has been tested under Ruby 1.9 and 2.0 on both Debian Wheezy (7.0) and Ubuntu
+Precise (12.04). [Ruby 1.8 can be made to work with small adjustments][oldruby].
+Under both Debian and Ubuntu you'll need the `libpam0g-dev` package to compile the
+`rpam` dependency.
-There are no configuration options. It's been tested under Debian 6.0 (Squeeze)
-and Ruby 1.9.3, but there's no reason why it won't work anywhere which doesn't
-have PAM correctly configured.
-_Note: The above is assumed for Sinatra, check the OmniAuth docs for Rails, et. al. usage._
+The included `Vagrantfile` provides a Debian Wheezy environment and the `example/`
+directory provides a working Sinatra example.
-Then navigate to '/auth/pam'.
+### Simple Sinatra Example
-On Debian/Ubuntu you will need the `libpam0g-dev` package to compile the [rpam][]
-gem. YMMV with others.
+But, getting it working is as simple as this:
-This strategy only supports Ruby 1.9. [Read here about 1.8 support][oldruby].
+```ruby
+require 'omniauth'
+require 'omniauth-pam'
-## Credits
+use Rack::Session::Cookie
+use OmniAuth::Strategies::PAM
-Originally hacked together by [Nick Charlton][nick], with modifications by
-[Jaakko Kantojärvi][jaakko] for GitLab support. Licensed under the MIT license.
+get '/auth/:provider/callback' do
+ puts request.env['omniauth.auth']
+end
+```
-[rpam]: https://github.com/canweriotnow/rpam-ruby19
+## Author
+
+Copyright (c) 2013 Nick Charlton and contributors. MIT Licensed.
+
[oldruby]: http://nickcharlton.net/post/pam-for-omniauth
-[nick]: https://github.com/nickcharlton
-[jaakko]: https://github.com/raphendyr