[docs] Readme

bmeck · Sep 20, 2012 · 724a483 · 724a483
1 parent c54b678
commit 724a483
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/readme.md b/readme.md
@@ -0,0 +1,26 @@
+# Flatiron-REPL
+
+## Allow your app to get a repl easily
+
+```javascript
+app.use(require('flatiron-repl'), {
+  port: 1337,
+  whitelist: [
+    '127.0.0.1',
+    {address:'10.0.0.1', port: '777'}
+  ]
+});
+```
+
+## Client executable included
+
+```bash
+rrepl 1337
+```
+
+And once we are in the REPL
+
+```javascript
+> app.config.get('database:url')
+'127.0.0.1:5984'
+```