aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDavid Phillips <david@sighup.nz>2017-04-30 20:31:47 +1200
committerDavid Phillips <david@sighup.nz>2017-04-30 20:31:47 +1200
commit6b4de44f04c0eed5a3cb997800d3f6d2d4a38605 (patch)
treec41ea93b02feadbac1d9208abaab9862be458e36 /README.md
parent17b3b7432e5e04f2171308796cdb72a5dd919919 (diff)
downloadsand-leek-6b4de44f04c0eed5a3cb997800d3f6d2d4a38605.tar.xz
Add simple usage note to readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/README.md b/README.md
index 7b51597..cb18582 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,23 @@
# sand leek
-## experimental vanity onion address whatchamacallit
+experimental vanity onion address whatchamacallit
+## Usage
+
+Typical usage is something like
+
+ sand-leek -s mycoolsite -t 4 > key.pem
+
+to spawn 4 worker threads each looking for a key for an address starting
+with 'mycoolsite'. It might find a private key for any of the addresses:
+
+ mycoolsite5avt44.onion
+ mycoolsiteane4hb.onion
+ mycoolsitewtetnf.onion
+ mycoolsiterkom5h.onion
+
+or a large number of other valid addresses. Beware of using too long a
+search. While you may luck out and get a key quickly, on average, it
+may take a very long time to crack a long search.
## Future work
I have every intention to add GPU capability to sand leek.