From 9398008deb3947ca525082fafdcb8d8e1ec0fe9a Mon Sep 17 00:00:00 2001 From: Nishant Arora Date: Mon, 2 Jan 2017 13:17:14 +0530 Subject: [PATCH] Updated README --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6a03166..bfb4db9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,14 @@ -# matterwiki -the official matterwiki node app + + +### Matterwiki is a simple wiki for teams + +People use it to store documentation, notes, culture guidelines, employee onboarding content and everything else they want to. + +Setup Instructions: + +1. Clone this repository `git clone http://github.com/matterwiki/matterwiki` +2. Run `npm install` +3. Edit `config.js` (present in the project root) and change the `auth_secret` value with any secret phrase. + **NOTE: This phrase will be used to encode and decode your access tokens. Keep it safe and private** +4. run `npm run build` +5. run `node index`