From 2c7f9c71030e6eb13287607d3d36eb21255a14ee Mon Sep 17 00:00:00 2001 From: Julian Lam Date: Mon, 17 Jun 2013 08:30:45 -0400 Subject: [PATCH] updated package.json to include git link, and updated README.md to include proper installation instructions --- README.md | 10 +++------- package.json | 5 +++-- 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 554097fb21..b10a1c906e 100644 --- a/README.md +++ b/README.md @@ -22,15 +22,11 @@ Next, obtain all of the dependencies required by NodeBB: $ cd nodebb $ npm install -Now we ensure that the configuration files are properly set up. NodeBB runs on port 4567 by default. The client side config can be set up thusly: +Initiate the setup script by running the app with the `--setup` flag: - $ cp public/config.default.json public/config.json + $ node app --setup -... and the server side config can be set up similarly: - - $ cp config.default.js config.js - -Ensure that `/public/config.json` points to the publically accessible IP/hostname of your forum, and that the values of the server side config are also set correctly (see below). +The default settings are for a local server running on the default port, with a redis store on the same machine/port. Lastly, we run the forum. diff --git a/package.json b/package.json index 6ce01eec26..cbb69a7d5c 100644 --- a/package.json +++ b/package.json @@ -31,8 +31,9 @@ "node-imagemagick": "0.1.8", "node-rss": "1.0.1" }, - "devDependencies": {}, - "optionalDependencies": {}, + "bugs": { + "url": "https://github.com/designcreateplay/NodeBB/issues" + }, "engines": { "node": "*" }