From e3c300b159b6f20be1bb14152ac656061d657eac Mon Sep 17 00:00:00 2001 From: Nick Charlton Date: Tue, 26 Feb 2013 13:11:20 +0000 Subject: [PATCH] Updates the README. --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b763a3b..b0c9db8 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,25 @@ Allows you to authenticate against PAM using OmniAuth. use OmniAuth:Strategies::PAM -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._ +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._ Then navigate to '/auth/pam'. -On Debian/Ubuntu you will need the `libpam0g-dev` package to compile the [rpam](https://github.com/canweriotnow/rpam-ruby19) gem. Others, I don't know. +On Debian/Ubuntu you will need the `libpam0g-dev` package to compile the [rpam][] +gem. YMMV with others. -This strategy only supports Ruby 1.9. [Read here about 1.8 support](http://nickcharlton.net/post/pam-for-omniauth). +This strategy only supports Ruby 1.9. [Read here about 1.8 support][oldruby]. -## Author / License +## Credits + +Originally hacked together by [Nick Charlton][nick], with modifications by +[Jaakko Kantojärvi][jaakko] for GitLab support. Licensed under the MIT license. + +[rpam]: https://github.com/canweriotnow/rpam-ruby19 +[oldruby]: http://nickcharlton.net/post/pam-for-omniauth +[nick]: https://github.com/nickcharlton +[jaakko]: https://github.com/raphendyr -Copyright Nick Charlton 2012. Licensed under the MIT license.