1. Szymon Wróblewski
  2. pygnetic

Source

pygnetic / doc / index.rst

Diff from to

File doc/index.rst

-``pygame_network`` --- Easy networking in Pygame
-================================================
+pygnetic --- Easy networking in Pygame
+======================================
 
-Network module for `Pygame <http://www.pygame.org>`_.
+**pygnetic** is a library designed to help in the development of
+network games and applications in `Pygame <http://www.pygame.org>`_.
+
+
+Features
+--------
+
+* Two approaches to handle network events
+   * generating events in pygame queue
+   * using handler classes
+* Efficient packaging of data through the message system
+* Support for multiple network and serialization libraries
+
 
 Contents
 --------
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 2
    :glob:
 
-   source/index
+   api/index
+   examples
    license
 
+
 Installation
 ------------
-This module uses `Pyenet <http://code.google.com/p/pyenet/>`_ for network communication and
-`Message Pack <http://msgpack.org/>`_ for data serialization.
 
+**pygnetic** can be installed with
+`windows installer <http://pypi.python.org/pypi/pygnetic/#downloads>`_
+or with `pip <http://www.pip-installer.org>`_::
 
-Usage
------
+   pip install pygnetic
 
-TODO
 
+Optional requirements
+---------------------
 
-Why should I use this module instead of X ?
--------------------------------------------
+* `Message Pack <http://msgpack.org/>`_ (recommended)
+* `pyenet <http://code.google.com/p/pyenet/>`_
 
-TODO
 
+Resources
+---------
 
-Support
--------
-
-TODO
-
-
-Development
------------
-
-The source code is hosted on
-`Bitbucket <https://bitbucket.org/bluex/pygame-networking-gsoc2012>`_::
-
-   hg clone https://bitbucket.org/bluex/pygame-networking-gsoc2012
+* Package on PyPI -- http://pypi.python.org/pypi/pygnetic
+* Repository on Bitbucket -- https://bitbucket.org/bluex/pygnetic
+* Documentation -- http://pygnetic.readthedocs.org
+* Development blog -- http://pygame-networking.blogspot.com
 
 
 Credits
 -------
 
-pygame_network is under development by Szymon Wróblewski <bluex0@gmail.com>
+pygnetic is under development by Szymon Wróblewski <bluex0@gmail.com>
 as `GSoC 2012 <http://code.google.com/soc/>`_ project and mentored by
 René Dudfield <renesd@gmail.com>.
 
-Development blog can be found here: http://pygame-networking.blogspot.com
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`