updated documentation

README.rst

@@ -0,0 +1,20 @@
+===========
+eventsocket
+===========
+:Info: See `the FreeSWITCH Event Socket documentation <http://wiki.freeswitch.org/wiki/Event_Socket>`_ for more information. See `github <http://github.com/fiorix/eventsocket/>`_ for the latest source.
+:Author: Alexandre Fiori <fiorix@gmail.com>
+:Author: Arnaldo M. Pereira <egghunt@gmail.com>
+
+About
+=====
+`eventsocket` is a Twisted protocol for the FreeSWITCH's Event Socket. This protocol provides support for both Inbound and Outbound methods of the Event Socket in a single-file class.
+
+It may be used for a wide variety of purposes. It aims to be simple and extensible, and to export all the functionality of the FreeSWITCH to Twisted-based applications.
+
+Moreover, it's totally event-driven and allows easy implementation of complex applications aiming at controlling the FreeSWITCH through the Event Socket.
+
+This code is part of the core of the `Nuswit Telephony API <http://nuswit.com>`_, a full featured web-based dialer currently operating in Brazil and Colombia.
+
+Examples
+========
+Examples are available in the `examples/ <http://github.com/fiorix/eventsocket/tree/master/examples/>`_ directory.

eventsocket.py

@@ -1,6 +1,6 @@
 # coding: utf-8
-# freeswitch's event socket protocol for twisted
-# Copyright (C) 2009  Alexandre Fiori & Arnaldo Pereira
+# Twisted protocol for the FreeSWITCH's Event Socket
+# Copyright (C) 2010 Alexandre Fiori & Arnaldo Pereira
 # 
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License
@@ -24,6 +24,8 @@
 from twisted.protocols import basic
 from twisted.internet import defer, reactor, protocol
 
+"Twisted protocol for the FreeSWITCH's Event Socket"
+
 class EventError(Exception):
     pass
 

examples/dialer.py

@@ -80,6 +80,7 @@ def main():
     factory = MyFactory(password="ClueCon")
     reactor.connectTCP("127.0.0.1", 8021, factory)
 
+    # Wait for the connection to be established
     try:
         client = yield factory.ready
     except Exception, e: