Various documentation fixes and additions.

[quix0rs-apt-p2p.git] / apt_dht / __init__.py

diff --git a/apt_dht/__init__.py b/apt_dht/__init__.py
index c4dcfb4748a1308bbf456e31c2576240f7fc721a..b945cecc62c30ca08dbcd6d0d80ee973236e9dcd 100644 (file)
--- a/apt_dht/__init__.py
+++ b/apt_dht/__init__.py
@@ -1,6 +1,13 @@
 
 """The main apt-dht modules.
 
 
 """The main apt-dht modules.
 

+To run apt-dht, you probably want to do something like::
+
+  from apt_dht.apt_dht import AptDHT
+  myapp = AptDHT(myDHT)
+
+where myDHT is a DHT that implements interfaces.IDHT.
+

 Diagram of the interaction between the given modules::
   
   +---------------+    +-----------------------------------+    +-------------
 Diagram of the interaction between the given modules::
   
   +---------------+    +-----------------------------------+    +-------------