From c6644da48399ff02b57254c193bb1398286fcf8b Mon Sep 17 00:00:00 2001
From: Timur Demin <me@tdem.in>
Date: Tue, 28 Jul 2020 23:47:11 +0500
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..be2304d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# SimpleYggGen-Go
+
+This program reimplements [SimpleYggGen](https://notabug.org/acetone/SimpleYggGen-Bash) in Go, importing the original Yggdrasil
+code for generating keys and utilizing multiple CPU threads for mining.
+
+### Installation
+
+`% go get -u -v git.tdem.in/tdemin/syg_go`
+
+### History
+
+SimpleYggGen is originally a project by [@acetone](https://notabug.org/acetone),
+who wrote a bash [miner](https://notabug.org/acetone/SimpleYggGen-Bash) for
+getting "magic" Yggdrasil addresses following a pattern. The main problem with
+his implementation was that it ran grep and yggdrasil as separate processes,
+making mining very slow. Even though acetone later made a C++ implementation, it
+still relies on running Yggdrasil as a separate process.
+
+### Performance
+
+Obviously far superior to the [original SimpleYggGen][dokuygg]
+(Yggdrasil link, you might need to install Yggdrasil to open this link).
+
+[dokuygg]: http://[300:529f:150c:eafe::6]/doku.php?id=yggdrasil:simpleygggen
+
+With multiple threads it takes SimpleYggGen **a month** to run through a few
+million cycles and find keys for `200::c84:77b0:f66d:b47e:64c7` (targeting
+`::`). syg_go has found keys for `206:bcdb::ac47:4e3b:b97e:df4e` with the same
+target in **27 minutes**, utilizing 8 threads on AMD Ryzen 1700X.
+
+With 8 threads on Ryzen 1700X while searching for `::` this program reaches:
+
+* 10 000 000 iterations in 2 minutes, 36 seconds
+* 100 000 000 iterations in 25 minutes, 58 seconds
+* 500 000 000 iterations in 2 hours, 10 minutes
+
+### License
+
+See [LICENSE](LICENSE).