From 2ac834252ef5d362a65cdcdb0ee897329cfefd8c Mon Sep 17 00:00:00 2001
From: Andrew Tomaka <atomaka@gmail.com>
Date: Sun, 21 Apr 2013 00:26:36 -0400
Subject: [PATCH] Initial commit

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..74718eb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+#devise-kerberos-authenticatable
+
+##Description
+
+devise-kerberos-authenticatable is a Devise exenstion that can be used to authenticate against Kerberos as setup in your local krb5.conf file.  
+
+##Installation
+
+###Dependencies
+[timfel-krb5-auth](https://github.com/timfel/krb5-auth) depends on the headers and development libraries for MIT Kerberos.
+```sudo apt-get install libkrb5-dev```
+###Server Setup
+Modify your /etc/krb5.conf file as necessary to authenticate against your Kerberos server.
+
+###Rails Setup
+* Edit config/initializers/devise.rb to use a username instead of email for login.
+```config.authentication_keys = [ :username ]```
+* Update your Devise model app/models/user.rb
+```
+devise :kerberos_authenticatable
+attr_accessible :username
+```
+* Rebuild your Devise views automatically or by hand.
+```
+rake generate devise:views
+```
+
+##Other
+* Currently only supports authentication and does not include password modification functionality.
+* Initial code based largely on [devise_pam_authenticatable](https://github.com/jwilson511/devise_pam_authenticatable)