Added as example app

1 files changed, 27 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..f5859c0
--- /dev/null
+++ b/README
@@ -0,0 +1,27 @@
+
+  // Flask-Pastebin //
+
+     This application implements an example pastebin with Flask,
+     Flask-OAuth, Flask-SQLAlchemy, Flask-Script, as well as
+     Juggernaut to show off some realtime things.
+
+  What can it do?
+
+    * Facebook Connect
+    * Realtime push notifications with Juggernaut
+    * Shows simple pagination
+
+  How to use it?
+
+    1. make a virtualenv
+    2. ``pip install -r requirements.rst``
+    3. ``python manage.py initdb``
+    4. ``python manage.py runserver``
+
+  Also make sure to run juggernaut.
+
+  How to install juggernaut?
+
+    $ npm install -g juggernaut
+
+