add readme

dc91efe3 · Michael Wozniak · 4beecb11 · dc91efe3
Commit dc91efe3 authored Mar 13, 2016 by Michael Wozniak
Hide whitespace changes
Inline Side-by-side

Showing with 18 additions and 0 deletions

README.md README.md +18 -0

No files found.
--- a/README.md
+++ b/README.md
+Stratum Proxy
+===========
+
+Stratum Proxy is a tool to add caching for certain functions for electrum clients.
+
+`go build` to build the program
+
+`stratum-proxy -host=server:port` to run the program
+
+The proxy will listen locally on port 8080
+
+
+TODO
+----
+
+Need to add config options
+
+Need to test multiple clients at once