From 6da36bb8591c527480bcf8643688bf27ab990200 Mon Sep 17 00:00:00 2001 From: Julian Lam Date: Mon, 22 Apr 2013 14:45:33 -0400 Subject: [PATCH] more tweaks to readme --- README.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b43e64f476..4feb3418f7 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,17 @@ ## Installation -1. `$ npm install` +First step is to obtain all of the dependencies requires by node-forum: -2. `$ apt-get install redis` + $ npm install -3. `$ node app` +Next, we install redis. If you have redis installed, you can skip this step. + + # apt-get install redis + +Lastly, we run the forum. + + $ node app ## Config @@ -22,4 +28,15 @@ node-forum is pre-configured to run on port 4567, with default options defined i port (Default: 4567) The default port that node-forum runs on + + mailer + + (Default: {
+     host: 'localhost',
+     port: '25',
+     from: 'mailer@localhost.lan'
+ })

+ Settings for the outgoing mailer (for emails involving user registration/password resets) + + \ No newline at end of file