Permalink
Browse files

Better npm citizenship: rename index.js to server.js, update package.…

…json
  • Loading branch information...
1 parent e12d555 commit 87fc58ced595600222820de2373a56c97be2da2e @mamacdon committed Dec 6, 2012
Showing with 13 additions and 8 deletions.
  1. +13 −6 README.md
  2. +0 −2 package.json
  3. 0 index.js → server.js
View
@@ -11,7 +11,7 @@ A minimal, single-user deployment of [Eclipse Orion](http://www.eclipse.org/orio
* Concatenation and minification of pages (requires a manual step, see **Concatenation + Minification**, below)
## Requirements
-* node.js
+* node.js (plus npm)
* A web browser
## Known Issues
@@ -22,11 +22,18 @@ A minimal, single-user deployment of [Eclipse Orion](http://www.eclipse.org/orio
* Once running, node apps currently do not exit automatically. They must be explicitly killed using ```node stop <pid>``` or by killing the server.
## Usage
-1. Checkout the orionode repository from GitHub.
-2. **Recommended:** create a one-line ```password.txt``` file containing a secret password.
-3. Launch the Orion server by running this command from a shell:
-```node index.js [-p port] [-w directory] [-password password.txt]```
-4. Go to **[http://localhost:8081](http://localhost:8081)** (or whatever port you chose) in your web browser to start using Orion.
+1. Checkout the orionode repository from GitHub. (Alternatively, you can install orionode using npm by running ```npm install orion```).
+2. If you checked out the repo from GitHub, download the dependencies by running:
+```npm install```
+3. **Recommended:** create a one-line ```password.txt``` file containing a secret password.
+4. Launch the Orion server by running one of the following commands from a shell.
+ * If you installed by checking out the Git repo:
+ ```node server.js [-p port] [-w directory] [-password password.txt]```
+ * If you installed using npm, the path to server.js will be different:
+ ```node ./node_modules/orionode/server.js [-p port] [-w directory] [-password password.txt]```
+ * If you're not passing any command-line arguments to the server, you can just do this:
+ ```npm start```
+5. Go to **[http://localhost:8081](http://localhost:8081)** (or whatever port you chose) in your web browser to start using Orion.
##### Optional command line arguments:
* ```-p``` or ```-port```: the port that the Orion server will listen on. Defaults to **8081**.
View
@@ -3,7 +3,6 @@
"version": "0.0.2",
"description": "An Eclipse Orion server based on Node.js and connect.",
"homepage": "http://eclipse.org/orion/",
- "main": "index.js",
"dependencies": {
"connect": "~2.4.6",
"node-inspector": "~0.2.0beta3",
@@ -12,7 +11,6 @@
},
"devDependencies": {},
"scripts": {
- "start": "node ./index.js",
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
View
File renamed without changes.

0 comments on commit 87fc58c

Please sign in to comment.