added block as process option and updated documentation. added typical use example to ClientXMPP.

2011-08-04 21:49:32 -07:00
parent caec2976d7
commit 7f90de887a
3 changed files with 43 additions and 8 deletions
--- a/sleekxmpp/clientxmpp.py
+++ b/sleekxmpp/clientxmpp.py
@@ -40,9 +40,12 @@ log = logging.getLogger(__name__)
 class ClientXMPP(BaseXMPP):

    """
-    SleekXMPP's client class.
+    SleekXMPP's client class. ( Use only for good, not for evil.)

-    Use only for good, not for evil.
+    Typical Use:
+    xmpp = ClientXMPP('user@server.tld/resource', 'password')
+    xmpp.process(block=False) // when block is True, it blocks the current
+    //                           thread. False by default.

    Attributes: