From: burris <burris>
Date: Tue, 3 Sep 2002 00:37:55 +0000 (+0000)
Subject: updated docs
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=feffbb586667387db66871efef39dc185f33c3c0;p=quix0rs-apt-p2p.git

updated docs
---

diff --git a/README.txt b/README.txt
index b692979..73c365d 100644
--- a/README.txt
+++ b/README.txt
@@ -1,9 +1,16 @@
 quick example:
 
-import khashmir, thread
-k = khashmir.Khashmir('127.0.0.1', 4444)
-thread.start_new_thread(k.dispatcher.run, ())
-k.addContact('127.0.0.1', 8080)  # right now we don't do gethostbyname
-k.findCloseNodes()
+>>> import khashmir
+>>> k = khashmir.test_one(4444)  # choose any port
+
+If you want to make another peer in the same session, use peer = khashmir.Khashmir(host, port) then do peer.app.run() to register with the already running thread.
+
+
+>>> k.addContact('127.0.0.1', 8080)  # locate another peer
+>>> k.findCloseNodes()  # query the network to bootstrap our table
+
+Keys are always 20-character strings (sha1 hashes)
+
+>>> k.storeKeyForValue(key, value)  # no callback right now
+>>> k.valueForKey(key, callback)
 
-alternatively, you can call k.dispatcher.runOnce() periodically from whatever thread you choose
\ No newline at end of file