From 6b4de44f04c0eed5a3cb997800d3f6d2d4a38605 Mon Sep 17 00:00:00 2001
From: David Phillips <david@sighup.nz>
Date: Sun, 30 Apr 2017 20:31:47 +1200
Subject: Add simple usage note to readme

---
 README.md | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

(limited to 'README.md')

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.
-- 
cgit v1.1