Merge branch 'master' of github.com:bradleyg/nserv

README.markdown

@@ -1,8 +1,7 @@
-Nserv wants to be a [Nodejitsu](http://nodejitsu.com/) / [Heroku](http://www.heroku.com/) / [No.de](https://no.de/) / [AppFog](http://appfog.com/) style PaaS for deploying node.js applciations which can be hosted on your own servers. Nserv uses [nodejitsu](http://nodejitsu.com/#technology) applications [forever](https://github.com/indexzero/forever) and [node-http-proxy](https://github.com/nodejitsu/node-http-proxy) so is running entirely on nodejs. A total works in progress, probably with a lot of bugs.
+Nserv wants to be a [Nodejitsu](http://nodejitsu.com/) / [Heroku](http://www.heroku.com/) / [No.de](https://no.de/) style PaaS for deploying node.js applciations which can be hosted on your own servers. Nserv uses [nodejitsu](http://nodejitsu.com/#technology) applications [forever](https://github.com/indexzero/forever) and [node-http-proxy](https://github.com/nodejitsu/node-http-proxy) so is running entirely on nodejs. A total works in progress, probably with a lot of bugs.
 
 ## Features:
 * Git deployment of applications
-* Automatic install of npm modules
 * Simple management of deployed applications
 
 ## Setup:
@@ -16,13 +15,19 @@ Nserv wants to be a [Nodejitsu](http://nodejitsu.com/) / [Heroku](http://www.her
 `[sudo] nserv stop`  
 `nserv create (domain)` - this will add the domain to nserv proxy table and start proxying requests  
 `nserv remove (domain)`  
-`nserv list`  
+`nserv list` - lists all applications  
 `nserv help`
 
-After adding an application you will be provided with a git remote that you can add to your local repo. Once added execute `git push nserv master` and your server will updated and restarted. For now your main server file must be called 'server.js'. If you provide a package.json file for npm modules add a .gitignore file to remove your node\_modules folder. Npm is installed on nserv and installs dependencies automatically. 
+You must first start the nserv server: `sudo nserv start`, this will create a http proxy table and route any domains added to it via: `nserv create domain.com`. Sudo privileges are required so the proxy server can listen on port 80.   
+
+After creating an application you will be shown a git remote within the console that you can add to your local repo. Once added execute `git push nserv master` and your app will be updated and restarted automatically.  
+
+For now your main server file must be called 'server.js' and your app must listen on `process.env.PORT`. ~~If you provide a package.json file for npm modules add a .gitignore file to remove your node\_modules folder. Npm is installed on nserv and installs dependencies automatically.~~  
 
 ## TODO:
 * Define the main server.js in the package.json
+* Automatic install of npm modules
+* Hard start and stop of applications (without the need to delete or update)  
 
 ## Good stuff:
 [npm](http://npmjs.org/)