1 files changed, 43 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..89a2990
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+Django authentification backend using Crowd REST API
+====================================================
+
+This is a very rough implementation of a django backend
+using Crowd's REST API.
+
+It is inspired by the various forks of django-crowd-backend.
+Those implementations were always using SOUP.
+This one simple because it's just using REST API supported by Crowd. 
+
+Current implementation
+======================
+
+- Connect to Crowd server
+- Authenticate given user by password
+- Sync Django user instance with attributes from Crowd user
+- Setup Djnago user staff/superuser flags based on associated Crowd groups of user
+
+Features
+========
+
+- HTTPS certificate validation when connecting to secure Crowd url
+
+Missing
+=======
+
+- No handling of SSO cookie
+
+Dependencies
+============
+
+- just 'urllib2' with a little tweak from https://github.com/josephturnerjr/urllib2.VerifiedHTTPS
+  to allow validation of https certificate.
+
+Problems ?
+==========
+
+Just send me a message. Let's see if I can help.
+
+License
+=======
+
+Use this code as you want. Consider it free. Say thank you. Don't blame me if it doesn't work for you.
+\ No newline at end of file