converted all Markdown to reStructuredText because this is understood…

… by PyPi

INSTALL.rst

@@ -0,0 +1,116 @@
+Installation and configuration guide
+====================================
+
+I assume that you have a basic understanding of XMPP and the the concept
+of a XMPP component / transport. If not, please get a book about Jabber
+or read the standards.
+
+transWhat is a XMPP transport. By this means it extends the
+functionallity of an existing XMPP server. It acts as a gateway between
+the XMPP and WhatsApp networks. It receives WhatsApp messages and
+forwards them to your XMPP client (and vice-versa).
+
+The implementation of transWhat is based on the `Spectrum 2`_ framework
+and the `Yowsup 2`_ library to interface with WhatsApp.
+
+The following chart summarizes the involved components and the protocols
+they use to communicate.
+
+Prosody
+-------
+
+Installation
+~~~~~~~~~~~~
+
+I will not cover the installation of Prosody in this guide. Please look
+for some other tutorials on how to do that.
+
+Configuration
+~~~~~~~~~~~~~
+
+The only important thing for us is the configuration of a XMPP component
+(Spectrum 2 in our case). See http://prosody.im/doc/components.
+
+Append the following at the end of ``/etc/prosody/prosody.cfg.lua``
+
+::
+
+    Component "whatsapp.0l.de"
+        component_secret = "whatsappsucks"
+        component_ports = { 5221 }
+        component_interface = "127.0.0.1"
+
+Spectrum 2
+----------
+
+Installation
+^^^^^^^^^^^^
+
+Manual compile latest version from `Github`_. You can use the following
+guide:
+http://spectrum.im/documentation/installation/from\_source\_code.html.
+
+Configuration
+^^^^^^^^^^^^^
+
+Create a new file ``/etc/spectrum2/transports/whatsapp.cfg`` with the
+following content:
+
+::
+
+    [service]
+    user = spectrum
+    group = spectrum
+
+    jid = whatsapp.0l.de
+
+    server = localhost
+    password = whatsappsucks
+    port = 5221
+
+    backend_host = localhost
+    backend = /location/to/transwhat/transwhat.py
+
+    users_per_backend = 10
+    more_resources = 1
+
+    admin_jid = your@jid.example
+
+    [identity]
+    name = transWhat
+    type = xmpp
+    category = gateway
+
+    [logging]
+    config = /etc/spectrum2/logging.cfg
+    backend_config = /etc/spectrum2/backend-logging.cfg
+
+    [database]
+    type = sqlite3
+
+transWhat
+---------
+
+Installation
+~~~~~~~~~~~~
+
+Checkout the latest version of transWhat from GitHub:
+
+::
+
+    $ git clone git@github.com:stv0g/transwhat.git
+
+Install required dependencies:
+
+::
+
+    $ pip install --pre e4u protobuf python-dateutil yowsup2
+
+-  **e4u**: is a simple emoji4unicode python bindings
+-  `**yowsup**`_: is a python library that enables you build application
+   which use WhatsApp service.
+
+.. _Spectrum 2: http://www.spectrum.im
+.. _Yowsup 2: https://github.com/tgalal/yowsup
+.. _Github: https://github.com/hanzz/libtransport
+.. _**yowsup**: https://github.com/tgalal/yowsup

README.rst

@@ -1,46 +1,62 @@
-# transWhat
+transWhat
+=========
 
-transWhat is a WhatsApp XMPP Gateway based on [Spectrum 2](http://www.spectrum.im) and [Yowsup 2](https://github.com/tgalal/yowsup).
+transWhat is a WhatsApp XMPP Gateway based on `Spectrum 2`_ and `Yowsup 2`_.
 
-#### Branches
+Branches
+^^^^^^^^
 
- - [yowsup-1](http://github.com/stv0g/transwhat/tree/yowsup-1) My original version which is based on @tgalal first Yowsup version (**deprecated** and broken).
- - [yowsup-2](http://github.com/stv0g/transwhat/tree/yowsup-2) Major rewrite from @moyamo for @tgalal's new Yowsup 2 (**recommended**).
- - [develop](http://github.com/stv0g/transwhat/tree/develop) A develop branch with the latest fixes and improvements. This branch is based on `yowsup-2`.
+-  `yowsup-1`_ My original version which is based on @tgalal first
+   Yowsup version (**deprecated** and broken).
+-  `yowsup-2`_ Major rewrite from @moyamo for @tgalal’s new Yowsup 2
+   (**recommended**).
 
-For production, please use the `yowsup-2` branch.
+For production, please use the ``yowsup-2`` branch.
 
-Please file bugreports against the `develop` branch.
+`Installation`_
+---------------
 
-## [Installation](INSTALL.md)
-## [Usage](USAGE.md)
+`Usage`_
+--------
 
-## Features
+`License`_
+----------
 
-  * Typing notifications
-  * Receive images, audio & video
-  * Set/get online status
-  * Set status message
-  * Groupchats
+Features
+--------
 
-## Contributors
+-  Typing notifications
+-  Receive images, audio & video
+-  Set/get online status
+-  Set status message
+-  Groupchats
 
-Pull requests, bug reports etc. are welcome. Help us to provide a open implementation of the WhatsApp protocol.
+Contributors
+------------
 
-The following persons have contributed major parts of this code:
-
-  - @stv0g (Steffen Vogel): Idea and initial implementation based on Yowsup 1
-  - @moyamo (Mohammed Yaseen Mowzer): Port to Yowsup 2
-  - @DaZZZl: Improvements to group chats, media & message receipts
+Pull requests, bug reports etc. are welcome. Help us to provide a open
+implementation of the WhatsApp protocol.
 
-## [License](COPYING.md)
+The following persons have contributed major parts of this code:
 
-transWhat is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+-  @stv0g (Steffen Vogel): Idea and initial implementation based on
+   Yowsup 1
+-  @moyamo (Mohammed Yaseen Mowzer): Port to Yowsup 2
+-  @DaZZZl: Improvements to group chats, media & message receipts
 
-Foobar is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+Links
+-----
 
-## Links
+An *outdated* project wiki is available `here`_.
 
-An *outdated* project wiki is available [here](https://dev.0l.de/wiki/projects/transwhat/).
+An *outdated* writeup of this project is also availabe at my `blog`_.
 
-An *outdated* writeup of this project is also availabe at my [blog](http://www.steffenvogel.de/2013/06/29/transwhat/).
+.. _Spectrum 2: http://www.spectrum.im
+.. _Yowsup 2: https://github.com/tgalal/yowsup
+.. _yowsup-1: http://github.com/stv0g/transwhat/tree/yowsup-1
+.. _yowsup-2: http://github.com/stv0g/transwhat/tree/yowsup-2
+.. _Installation: INSTALL.rst
+.. _Usage: USAGE.rst
+.. _License: COPYING.rst
+.. _here: https://dev.0l.de/wiki/projects/transwhat/
+.. _blog: http://www.steffenvogel.de/2013/06/29/transwhat/