Improved documentation

panleone · Nov 21, 2022 · a755d49 · a755d49
1 parent dc5e395
commit a755d49
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 4 deletions.
diff --git a/.env.mpw.sample b/.env.mpw.sample
@@ -1,4 +1,4 @@
-RPC_CREDENTIALS=masternode_test:p
+RPC_CREDENTIALS=name:password
 ALLOWED_RPCS=listmasternodes,relaymasternodebroadcast,getbudgetprojection,mnbudgetrawvote,getbudgetinfo
 PORT=3000
 RPC_PORT=51473

diff --git a/.env.sample b/.env.sample
@@ -1,5 +1,5 @@
-RPC_CREDENTIALS=masternode_test:p
-ALLOWED_RPCS=help,listmasternodes
+RPC_CREDENTIALS=name:password
+ALLOWED_RPCS=help,getbalance
 PORT=3000
 RPC_PORT=51473
 TESTNET_RPC_PORT=51463 # Remove if you don't want testnet
diff --git a/README.md b/README.md
@@ -1,2 +1,19 @@
 # PivxNodeController
-http server used to control a node remotely
+Simple http server used to perform RPC calls to a Bitcoin based node
+
+# HOW TO RUN
+
+First, download the dependencies with 
+```bash
+npm i
+```
+Then, copy the example environment file with
+```bash
+cp .env.sample .env
+```
+If you are setting up a node for MPW, copy `.env.mpw.sample` instead.
+Edit the file by chaning the credentials using the ones you set on your crypto node.
+Finally, run the server with
+```bash
+npm run start
+```