From 634f48322ecdb6ddfbac828a902a92d1cff997fc Mon Sep 17 00:00:00 2001
From: Nguyen Nguyen <nguyenbk92@gmail.com>
Date: Tue, 13 Nov 2018 17:15:30 +0700
Subject: [PATCH] TomoMaster: update readme

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/README.md b/README.md
index 4ca1d5d5..a7baa020 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,8 @@
 This is Governance Dapp for TomoChain. Full-Node can apply to become a candidate for masternode. Coin Holder can vote for candidates to become masternodes. See the detail from technical Whitepaper: https://docs.tomochain.com/whitepaper/](https://docs.tomochain.com/whitepaper/)
 
 ## Requirements
+- NodeJS (If you get EACCES permission issue, please see: https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally)
+- Redis
 - MongoDB
 - Truffle Framework
 
@@ -16,6 +18,38 @@ This is Governance Dapp for TomoChain. Full-Node can apply to become a candidate
 cp config/default.json config/local.json
 ```
 Update `local.json` file to support your environment
+- Update mnemonic
+- Update mongodb configuration:
+    - For docker:
+    `  "db": {
+    "uri": "mongodb://mongodb:27017/governance"
+    },
+  `
+    - For localhost: 
+    `
+    "db": {
+    "uri": "mongodb://localhost:27017/governance"
+  },
+  `
+  - Update redis configuration:
+    - For docker:
+    `
+    "redis": {
+    "host": "redis",
+    "port": 6379,
+    "password": null,
+    "prefix": "tomomaster"
+    },
+    `
+    - For localhost:
+    `
+    "redis": {
+    "host": "localhost",
+    "port": 6379,
+    "password": null,
+    "prefix": "tomomaster"
+    },
+  `
 
 ## Install
 ```
@@ -26,6 +60,9 @@ cp abis/*json build/contracts/
 Note: before deploying to tomochain testnet, make sure you have TOMO in the wallet. If not, get free at [https://faucet.tomochain.com](https://faucet.testnet.tomochain.com)
 
 ## Run
+- Start mongodb
+- Start Redis
+- Start TomoMaster
 ```
 npm run dev
 ```