From 3a087559c41b9333fea7f6a890f837e03f9c4818 Mon Sep 17 00:00:00 2001
From: Timur Demin <me@tdem.in>
Date: Tue, 13 Oct 2020 23:47:41 +0500
Subject: [PATCH] Update README on cmdline flags meaning and usage

---
 README.md | 52 +++++++++++++++++++++++++++++++++-------------------
 1 file changed, 33 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index 14c10ec..ea0738a 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,39 @@ If you're an Arch Linux user, you can install it from
 
 `% yay -S syg_go`
 
+### Features
+
+* regex-based key mining (see `-regex`)
+* bruteforce-resistant keys mining mode (see `-highaddr`)
+* multithreaded key mining (see `-threads`)
+
+### Usage
+
+```
+% syg_go -help
+Usage of syg_go:
+  -highaddr
+        high address mining mode, excludes regex
+  -iter uint
+        per how many iterations to output status (default 100000)
+  -original
+        use original Yggdrasil code
+  -regex string
+        regex to match addresses against (default "::")
+  -threads int
+        how many threads to use for mining (default 16)
+  -version
+        display version
+```
+
+This program outputs keys found to stdout and iterations numbers reached
+to stderr so that users can redirect the (possibly) irrelevant status
+output to /dev/null. To redirect status output to /dev/null, run:
+
+```
+% syg_go ...flags... 2>/dev/null
+```
+
 ### History
 
 [SimpleYggGen](https://notabug.org/acetone/SimpleYggGen-Bash) is originally a
@@ -50,25 +83,6 @@ This program contains some modded code from Yggdrasil that aims to improve
 performance. If you prefer to use original Yggdrasil code, set `-original`
 flag.
 
-### Usage
-
-```
-% syg_go -help
-Usage of syg_go:
-  -highaddr
-        high address mining mode, excludes regex
-  -iter uint
-        per how many iterations to output status (default 100000)
-  -original
-        use original Yggdrasil code
-  -regex string
-        regex to match addresses against (default "::")
-  -threads int
-        how many threads to use for mining (default 16)
-  -version
-        display version
-```
-
 ### Development
 
 `go tool pprof` support is available when building with `-tags debug`. The