Permalink
Browse files

Updating the Readme

  • Loading branch information...
1 parent ff12800 commit 059caa0dd0db26d6d3edd4a2cbe5af62269ae904 @mdp committed Nov 10, 2009
Showing with 19 additions and 7 deletions.
  1. +19 −7 README.markdown
View
26 README.markdown
@@ -1,20 +1,32 @@
# Simple Admin
-### A database-less admin authentication based on OpenID
+## A database-less admin authentication based on OpenID
-Provides a thin wrapper around the excellent ruby-openid gem from JanRan. Be sure to install that first:
+### Requires the following gems
- gem install ruby-openid
+ * ruby-openid
+ * rack-openid
## Installation
-Install the plugin and add the before filter
+#### Install the plugin
+
+ script/plugin install git://github.com/markpercival/simple_admin.git
+
+#### Add the following before filter to any protected controllers
before_filter :ensure_admin
+
+#### List the authorized OpenId's in 'config/simple_admins.yml'
+
+ - markpercival.us
+ - mark.squarepush.com
+
+### When you login you should see this
-## Helpers
+![Login](http://img.skitch.com/20091110-fcteijh6y74q3qxm53ed7qyfr5.jpg 'Login Screen')
The following helpers are available in your controller and views:
- * current_user - returns the current authenticated user
- * authorized? - tells you whether or not the current session is authenticated
+ * current_user - returns the current authenticated user
+ * authorized? - tells you whether or not the current session is authenticated

0 comments on commit 059caa0

Please sign in to comment.