summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorfireice-uk <fireice-uk@users.noreply.github.com>2017-07-18 21:59:26 +0100
committerfireice-uk <fireice-uk@users.noreply.github.com>2017-07-18 21:59:26 +0100
commitf4b988c3b155295fb48d05a799c1ac4e8d3e83b6 (patch)
treeeda91c0ec2fb56a2c6feae4436325f828c98095d /README.md
parent7b05d559260e9a1ae2f655b89a953457a34ed473 (diff)
downloadxmr-stak-f4b988c3b155295fb48d05a799c1ac4e8d3e83b6.zip
xmr-stak-f4b988c3b155295fb48d05a799c1ac4e8d3e83b6.tar.gz
Add README section
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index c71afdd..148d9d9 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,10 @@ XMR-Stak is a universal Stratum pool miner. This is the CPU-mining version; ther
## HTML reports
<img src="https://gist.githubusercontent.com/fireice-uk/2da301131ac01695ff79539a27b81d68/raw/4c09cdeee86f94df2e9dd86b927e64aded6184f5/xmr-stak-cpu-hashrate.png" width="260"> <img src="https://gist.githubusercontent.com/fireice-uk/2da301131ac01695ff79539a27b81d68/raw/4c09cdeee86f94df2e9dd86b927e64aded6184f5/xmr-stak-cpu-results.png" width="260"> <img src="https://gist.githubusercontent.com/fireice-uk/2da301131ac01695ff79539a27b81d68/raw/4c09cdeee86f94df2e9dd86b927e64aded6184f5/xmr-stak-cpu-connection.png" width="260">
+## HTML and JSON API report configuraton
+
+To configure the reports shown above you need to edit the httpd_port variable. Then enable wifi on your phone and navigate to <miner ip address>:<httpd_port> in your phone browser. If you want to use the data in scripts, you can get the JSON version of the data at url <miner ip address>:<httpd_port>/api.json
+
## Usage on Windows
1) Edit the config.txt file to enter your pool login and password.
2) Double click the exe file.
OpenPOWER on IntegriCloud