Commits

pystew committed 0f112c5

readme

Comments (0)

Files changed (1)

           Python : http://www.python.org
          Citadel : http://www.citadel.org
 Citadel Protocol : http://www.citadel.org/doku.php/documentation:applicationprotocol
+
+ - tcp.py defines a fairly generic TCP client in the Client class.
+ - api.py implements the Citadel Protocol on top of tcp.Client.
+ - citadel.py is the high level Citadel interface.
+ - tpl.py contains templates needed by the Citadel client.
+
+ You shouldn't have to worry about tcp.py, api.Protocol is the class where you would implement missing parts of the low level Citadel Protocol and citadel.py should be the only module you need to import and adapt to your needs.