Permalink
Browse files

goals docstring

git-svn-id: https://svn.defuze.org/oss/headstock@986 5b3156b2-dc0e-0410-86c6-8c750cf32934
  • Loading branch information...
1 parent 62dbae4 commit de52531b624935ab01daab6fe500738788cff445 sylvain committed Nov 9, 2009
Showing with 16 additions and 0 deletions.
  1. +16 −0 docs/tutorial.rst
View
@@ -9,6 +9,22 @@ you through the various aspects of the library.
First make sure you have followed the :ref:`getting_started` guide
prior to go through this tutorial.
+Goals
+=====
+
+The main idea behind headstock is not to provide a complete API
+mapping the XMPP specifications but to offer a very basic
+set of tools to:
+
+* handle the connection
+* create the XMPP stream
+* deal with incoming stanzas with as little overhead
+on your application as possible
+
+It tries to act as library rather than a framework
+as much as possible.
+
+
Initialize the XMPP client and stream
=====================================
The most basic use of the client:

0 comments on commit de52531

Please sign in to comment.