Add more documentation

1 files changed, 31 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..f5da6ed
--- /dev/null
+++ b/README
@@ -0,0 +1,31 @@
+jrrd 0.0.1
+
+
+What is this?
+=============
+Wrappers and convenience fuctions for working with the javascriptRRD, Flot and
+Collectd.
+
+
+Debian / Ubuntu Quick Start
+===========================
+To get this demo working, you will need to serve this page from a
+local webserver and serve the folder that contains your RRD files.
+
+This demo is designed to work with the RRD files generated by
+<a href="http://collectd.org/">Collectd</a>.
+
+# Install and configure collectd (enable the rrd plugin)
+$ aptitude install collectd
+
+# Create a project folder
+$ mkdir -p ~/Projects/jrrd
+$ cd ~/Projects/jrrd
+
+# Link to the collectd rrd folder
+$ ln -f /var/lib/collectd/rrd/localhost data
+
+# Start a local webserver
+$ aptitude install twisted
+$ twistd -n web --port 8080 --path .
+