From: Cameron Dale <camrdale@gmail.com>
Date: Wed, 5 Mar 2008 23:03:33 +0000 (-0800)
Subject: Document the DHT package.
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=04e422d1ddc237684b4b236aff984d2f76ec2c8c;p=quix0rs-apt-p2p.git

Document the DHT package.
---

diff --git a/apt_dht_Khashmir/__init__.py b/apt_dht_Khashmir/__init__.py
index e69de29..cd6f7e8 100644
--- a/apt_dht_Khashmir/__init__.py
+++ b/apt_dht_Khashmir/__init__.py
@@ -0,0 +1,22 @@
+
+"""The apt-dht implementation of the Khashmir DHT.
+
+These modules implement a modified Khashmir, which is a kademlia-like
+Distributed Hash Table available at::
+
+  http://khashmir.sourceforge.net/
+
+The protocol for the implementation's communication is described here::
+
+  http://www.camrdale.org/apt-dht/protocol.html
+
+To run the DHT you probably want to do something like::
+
+  from apt_dht_Khashmir import DHT
+  myDHT = DHT.DHT()
+  myDHT.loadConfig(config, section)
+  myDHT.join()
+
+at which point you should be up and running and connected to others in the DHT.
+
+"""