Update README.md

README.md

@@ -1,2 +1,67 @@
-# QuantumMiner
-Nvidia and AMD GPU miner for ETH, ETC, RVN, FIRO
+# QuantumMiner-v1.0
+
+Nvidia and AMD GPU miner for `ETH`, `ETC`, `RVN`, `FIRO`
+
+## Features
+* Support Windows. (Linux version will be available soon)
+* Support DNS-Over-TLS
+* Support SOCKS5 proxy
+* Support SSL/TLS connection
+* Support backup pool configuration
+* Support watchdog
+* Dev Fee of all algorithms is 0.5%
+
+## Usage
+
+Example usage: QuantumMiner --algo ethash --pool eu1.ethermine.org:5555 --ssl --wallet 0xabcd1234abcd1234abcd1234abcd1234abcd1234
+
+    --help           Show help text and exit
+
+    --algo           One of ethash, etchash, kawpow, firopow
+
+    --pool           Primary stratum pool URL
+                     Format: hostname:port, e.g. eu1.ethermine.org:4444
+
+    --wallet         Primary stratum pool wallet
+                     e.g. 0xabcd1234abcd1234abcd1234abcd1234abcd1234
+
+    --ssl            Enable ssl connection on primary pool
+
+    --backup-pool    Backup stratum pool URL
+                     Format: hostname:port, e.g. eu1.ethermine.org:4444
+
+    --backup-wallet  Backup stratum pool wallet
+                     e.g. 0xabcd1234abcd1234abcd1234abcd1234abcd1234
+
+    --backup-ssl     Enable ssl connection on backup pool
+
+    --worker-name    Custom name of current worker, default: default_worker
+
+    --tlimit         Default is 0
+                     Stop mining when GPU temperature is above
+
+    --tresume        Default is 0
+                     Resume mining when GPU temperature is below if GPU was overheated, Must be lower than --tlimit
+
+    --devices        Default not set, e.g. --devices 0 2 3
+                     If not set all available devices will be used
+
+    --no-watchdog    Running QuantumMiner without launching watchdog process
+
+    --list-device    Print available devices and exit
+
+    --log            Enable writing console output to file
+
+    --enable-dot     Enable DNS over TLS
+
+    --proxy          SOCKS5 proxy, format: e.g. --proxy 127.0.0.1:10808
+
+    --no-hwstat      Disable printing hardware stat information
+
+    --no-validation  Disable CPU validation before submitting share to pool
+
+## Change log
+
+#### v1.0
+- Initial release
+