Permalink
Browse files

Readme update

  • Loading branch information...
1 parent adeab32 commit 713a690d38b7c152b728aa8b033d9785a6bddb44 @FGRibreau committed Nov 24, 2011
Showing with 83 additions and 4 deletions.
  1. +27 −0 LICENSE
  2. +56 −4 README.md
View
27 LICENSE
@@ -0,0 +1,27 @@
+Copyright (c) 2011, Francois-Guillaume Ribreau <node@fgribreau.com>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+ * Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+ * Neither the name of forever-webui nor the names of its contributors
+ may be used to endorse or promote products derived from this software
+ without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
View
@@ -1,19 +1,71 @@
-#Forever Web UI beta
-### Simple web UI for efficient nodejs administration
+# Forever Web UI beta
+Simple web UI for efficient NodeJS administration.
Just a little experimentation with Backbone.js
![Screen shot v0.1.0](/fgribreau/forever-webui/raw/master/public/img/v0.1.0.png)
-#### One liner
+## Installation
+
+### Via npm (node package manager)
+
+``` bash
npm install forever-webui && node node_modules/forever-webui/app.js
+```
and browse ```http://127.0.0.1:8085```
+
#### Via Git + NPM
+``` bash
git clone git@github.com:FGRibreau/forever-webui.git
@RobertWHurst

RobertWHurst Dec 11, 2011

Just to let you know that no one will be able to clone your repo because you have your private git url here. it should be https://github.com/FGRibreau/forever-webui.git instead of git@github.com:FGRibreau/forever-webui.git.

@FGRibreau

FGRibreau Dec 11, 2011

Owner

Fixed, thanks !

@RobertWHurst

RobertWHurst Dec 11, 2011

No problem, thanks for sharing your project.

cd forever-webui/
npm install
node app.js
+```
+
+and browse ```http://127.0.0.1:8085```
+
+## Usage
+
+Start NodeJS processes with forever cli and manage them via a web interface.
+
+### TODO
+
+* Starting process directly from the web interface
+* Save the last X processes stopped via the web for later restart.
+
+
+### Licence
+
+Copyright (c) 2011, Francois-Guillaume Ribreau <node@fgribreau.com>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+ - Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+ - Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+ - Neither the name of forever-webui nor the names of its contributors
+ may be used to endorse or promote products derived from this software
+ without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+#### Author: [Francois-Guillaume Ribreau][0]
-and browse ```http://127.0.0.1:8085```
+[0]: http://fgribreau.com

0 comments on commit 713a690

Please sign in to comment.