diff --git a/.gitignore b/.gitignore index db2bf00d5a..771027916c 100644 --- a/.gitignore +++ b/.gitignore @@ -5,4 +5,5 @@ npm-debug.log node_modules/ !/node_modules/ -!src/node_modules/ \ No newline at end of file +!src/node_modules/ +sftp-config.json diff --git a/README.md b/README.md index e0411f30d6..b84dbd8e4e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,23 @@ -Installation +# node-forum +**node-forum** is a robust nodejs driven forum built on a redis database. -1. npm install +## Installation -2. sudo node app +1. `$ npm install` +2. `node app` + +## Config + +node-forum is pre-configured to run on port 4567, with default options defined in config.json. The following options are available: + +
Option | +Description | +
---|---|
port | +(Default: 4567) The default port that node-forum runs on | +