From a443774ad7d39d29ccffc3b311afcd9a6cb92776 Mon Sep 17 00:00:00 2001
From: cgeek <cem.moreau@gmail.com>
Date: Sat, 25 Apr 2020 10:09:54 +0200
Subject: [PATCH] [doc] README: installation instructions

---
 README.md | 30 ++++++++++++++++++++++++++++++
 readme.md | 43 -------------------------------------------
 2 files changed, 30 insertions(+), 43 deletions(-)
 delete mode 100755 readme.md

diff --git a/README.md b/README.md
index 8b13789..468dd6a 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,31 @@
+# Currency-Monit Module
 
+## Installation for developers
+
+### Requirements
+
+* Nodejs 9.x.x
+* Python
+
+### Dependencies and transpilation
+
+    npm install -g yarn
+    yarn
+    
+### First sync and start
+
+Synchronize on a currency (for example Ğ1):
+
+    node run.js sync g1.duniter.org
+    
+Then start currency-monit:
+
+    node run.js currency-monit
+    
+> Tip: for development purposes you may not need the whole blockchain which is long to index. You can limit the sync to 1000 for example to speed up the process:
+>
+>     node run.js sync g1.duniter.org 1000
+
+### Access
+
+Then visit [http://localhost:10500](http://localhost:10500).
diff --git a/readme.md b/readme.md
deleted file mode 100755
index abeffb6..0000000
--- a/readme.md
+++ /dev/null
@@ -1,43 +0,0 @@
-# Currency-Monit Module
-
-Requires Duniter 1.6.22 or higher
-
-## Installation
-
-**Warning: only tar.gz format works ! Don't use zip format.**
-
-### If you use web-ui, install it very easy:
-
-1. go to localhost:9220/#/main/settings/modules
-and at the foot of page enter:
-```bash
-<<<<<<< HEAD
-https://github.com/duniter/duniter-currency-monit/archive/0.3.7.tar.gz
-=======
-duniter-currency-monit@0.4.5
->>>>>>> dev2
-```
-
-then clik to button INSTALL THIS MODULE
-
-2. restart your duniter node
-
-### If you don't use web-ui:
-
-1. download and uncompress archive at the location of your choice
-2. plug the plugin to your duniter node:
-
-```bash
-<<<<<<< HEAD
-duniter plug https://github.com/duniter/duniter-currency-monit/archive/0.3.7.tar.gz
-=======
-duniter plug duniter-currency-monit@0.4.5
->>>>>>> dev2
-```
-
-3. Stop your duniter node and restart it in the following method:
-```bash
-duniter currency-monit [host] [port]
-```
-
-then visit `host:port` (default is `localhost:10500`)
\ No newline at end of file
-- 
GitLab