Permalink
Browse files

Updated README.rdoc - but still not quite there

  • Loading branch information...
1 parent 470476d commit 1bfb68ec2ca0dc23c7e1c229cc28b2bed52159b5 Christian Frichot committed Nov 21, 2011
Showing with 14 additions and 2 deletions.
  1. +14 −2 README.rdoc
View
@@ -1,6 +1,18 @@
-= devise_google_authenticator
+= Devise Google Authenticator
+
+This is a devise[https://github.com/plataformatec/devise] extension to allow your app to utilise Google Authenticator[http://code.google.com/p/google-authenticator/] for Time-based One Time Passwords (TOTP).
+
+== Changes
+* Version 0.1 - initial release, just to push it up, is still very early and requires a bit work
+
+== Usage
+* After getting devise working with your rails app, add a 'require devise_google_authenticator' line.
+* Modify your user model (through a migration) and add t.gauth_secret and t.gauth_enabled
+* Modify your user model (through its model file) and include :google_authenticatable to your 'devise' line
+* Modify your user model (through its model file) and include :gauth_enabled into your model's attr_accessible
+* Ensure you've installed devise's views, and modify the sessions .. #CF TODO
+* Migrate your db
-Description goes here.
== Contributing to devise_google_authenticator

0 comments on commit 1bfb68e

Please sign in to comment.