Adding readme

lefnire · Nov 13, 2012 · 801ce5b · 801ce5b
1 parent 1bb52b8
commit 801ce5b
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
-node_modules
+node_modules
+npm-debug.log
diff --git a/README.md b/README.md
@@ -0,0 +1,8 @@
+# Derby.js Authentication
+
+Provides authentication middleware (using [Everyauth](https://github.com/bnoguchi/everyauth/tree/express3)) for use in your Derby projects. Currently only supports Facebook integration, but more integration is on the way. Please do scratch your own itch with other Everyauth implementations and provide pull requests. See [Everyauth's sample code](https://github.com/bnoguchi/everyauth/tree/express3/example) for details. For usage details, see [lefnire/derby-examples/authentication](https://github.com/lefnire/derby-examples/blob/master/authentication); specifically, [server/index.js](https://github.com/lefnire/derby-examples/blob/master/authentication/src/server/index.coffee).
+
+## Caveats
+ * Keys are set as environment variables (~/.profile) instead of a conf file for security-sake - it's how sensitive variables 
+are accessed on PaaS providers such as Heroku.
+ * Password authentication may prove difficult. See [this issue](https://groups.google.com/d/msg/derbyjs/JuUqUNd9Rls/MgHOXuYwDMgJ) for details, but the gist is derby-auth may be moving to Passport in the near future.