From 9e4be06b20cc5875f78233a6cbfd3aa18e062229 Mon Sep 17 00:00:00 2001
From: Duncan McGreggor <duncan@dreamhost.com>
Date: Mon, 23 Apr 2012 10:07:04 -0400
Subject: Added a README for the demo app.

---
 demoapp/README.rst | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 demoapp/README.rst

(limited to 'demoapp')

diff --git a/demoapp/README.rst b/demoapp/README.rst
new file mode 100644
index 0000000..89043a6
--- /dev/null
+++ b/demoapp/README.rst
@@ -0,0 +1,35 @@
+Running demoapp
+===============
+
+Setup
+-----
+
+First, you need to create a virtual environment and switch to it::
+
+ $ pip install virtualenv
+ $ virtualenv .venv
+ $ . .venv/bin/activate
+
+Now, install the demo into the virtual environment::
+
+ $ python setup.py install
+
+Usage
+-----
+
+With cliff and the demo setup up, you can now play with it.
+
+Here are a list of the commands available::
+
+ XXX
+
+Here is some example usage::
+
+ XXX
+
+Cleaning Up
+-----------
+
+Finally, when done, deactivate your virtual environment::
+
+ $ deactivate
-- 
cgit v1.2.1