From ba7a03b38782d95c2a784974f59e1649a06b9f26 Mon Sep 17 00:00:00 2001
From: manfromafar <jonsonb10@gmail.com>
Date: Fri, 30 Apr 2021 17:39:07 -0600
Subject: [PATCH] Create README.md

---
 README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1215fc2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+# Goldshellminer-cli
+
+### Introduction
+
+It is a mining software to interact with goldshell home-mining device (HS1, HS1-Plus)
+
+HS1: https://www.goldshell.com/hs1-handshake-miner-intro/   
+
+HS1-Plus:  https://www.goldshell.com/hs1-handshake-miner-intro/  
+
+
+### Mining Guide
+
+Tested on Linux, Windows and Mac OS. 
+
+#### 1.Install Node.js 
+```v10.15.3``` is recommended and tested
+#### 2.Clone code
+ ```$:git clone https://github.com/goldshellminer/goldshellminer-cli.git```
+#### 3.Install dependency
+```$:npm install```
+#### 4.Config pool
+Config `./config.json` to set your pool.
+###### DXPOOL for example
+``` json
+{
+  "loglevel": -1,
+  "miners": [
+    {
+      "cryptoname": "hns",
+      "minername": ["Goldshell-HS1", "Goldshell-HS1-Plus"],
+      "pool": {
+        "host": "hns.ss.dxpool.com",
+        "port": 3009,
+        "user": "USERNAME.WORKERNAME",
+        "pass": "x"
+      }
+    }
+  ]
+}
+```
+#### 5.Start Mining
+```$:npm run dashboard ```
+
+#### 6.Stop Mining
+(Ctrl+C, Q, or ESC to stop the dashboard miner)