From 27fe579a400d5713ab992ec6a81ba89e8109f30a Mon Sep 17 00:00:00 2001
From: Derek Lindahl <dlindahl@customink.com>
Date: Sun, 18 Dec 2011 21:53:58 -0500
Subject: [PATCH] Added some brief usage guidelines to the README

---
 README.md | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 6ea50fc..3fc0b57 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,25 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Use like any other OmniAuth strategy:
+
+    Rails.application.config.middleware.use OmniAuth::Builder do
+        provider :cas, :host => 'cas.yourdomain.com'
+    end
+
+OmniAuth CAS requires at least one of the following two configuration options:
+
+  * `host` - Defines the host of your CAS server. A default login URL of `/login` will be assumed.
+  * `login_url` - Defines the URL used to prompt users for their login information.
+    If no `host` is configured, the host application's domain will be used.
+
+Other configuration options:
+
+  * `port` - The port to use for your configured CAS `host`
+  * `ssl` - TRUE to connect to your CAS server over SSL.
+  * `service_validate_url` - The URL to use to validate a user. Defaults to `/serviceValidate`
+  * `logout_url` - The URL to use to logout a user. Defaults to '/logout'
+  * `uid_key` - The user data attribute to use as your user's unique identifier. Defaults to `user` (usually their login name)
 
 ## Contributing
 
-- 
GitLab