From: Paul J R <me@pjr.cc>
Date: Wed, 16 Jan 2013 19:55:17 +0000 (+1100)
Subject: just a bit of info added to the readme
X-Git-Url: http://git.pjr.cc/?a=commitdiff_plain;h=b4534625d417b269f00e8817a3308d63b02a859a;p=random_node_code.git

just a bit of info added to the readme
---

diff --git a/README.md b/README.md
index 3fbf823..d322b37 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,25 @@ nodejs_lxc_template
 ===================
 
 A nodejs template for lxc (linux containers) for running nodejs apps within a confined space.
+
+Inside the virtualised container, there is only two binaries - nodejs and "ip", everything else is a nodejs
+script.
+
+Startup (init) is handle by a nodejs script that sets the ip address/route/dns info based on a config file
+
+Apps are then put into the container by adding them to the /node_base directory, the init script will then
+read the /node_base/appconfig file to determine which app's it needs to start (and keep running) inside the
+container.
+
+
+How It Works
+============
+
+The nodejs template currently doesnt work as it stands but in the long term what it will do is:
+
+1) create a container by downloading a nodejs binary from the nodejs site (or from a supplied file)
+2) install the "ip" command (for interface/route setup)
+3) setup the base structure for the container
+4) install the node binary
+5) setup the init nodejs script
+6) ... magic!
\ No newline at end of file