Document the DHT package.

diff --git a/apt_dht_Khashmir/__init__.py b/apt_dht_Khashmir/__init__.py
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..cd6f7e87e1576f96e97e8042753c61b13e1c96b5 100644 (file)
--- 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.
+
+"""