diff --git a/README.rst b/README.rst index d76a930..f7ef9d1 100644 --- a/README.rst +++ b/README.rst @@ -3,8 +3,16 @@ transWhat transWhat is a WhatsApp XMPP Gateway based on `Spectrum 2`_ and `Yowsup 2`_. +Installation +------------ + +transWhat requires a running and configured XMPP server. +Detailed instructions can be found on the `Installation`_ page. + +Users find details on the `Usage`_ page. + Branches -^^^^^^^^ +-------- - `yowsup-1`_ My original version which is based on @tgalal first Yowsup version (**deprecated** and broken). @@ -13,15 +21,6 @@ Branches For production, please use the ``yowsup-2`` branch. -`Installation`_ ---------------- - -`Usage`_ --------- - -`License`_ ----------- - Features -------- @@ -44,12 +43,16 @@ The following persons have contributed major parts of this code: - @moyamo (Mohammed Yaseen Mowzer): Port to Yowsup 2 - @DaZZZl: Improvements to group chats, media & message receipts +License +------- + +transWhat is licensed under the GPLv3_ license. + Links ----- -An *outdated* project wiki is available `here`_. - -An *outdated* writeup of this project is also availabe at my `blog`_. +- An *outdated* project wiki is available `here`_. +- An *outdated* writeup of this project is also availabe at my `blog`_. .. _Spectrum 2: http://www.spectrum.im .. _Yowsup 2: https://github.com/tgalal/yowsup @@ -57,6 +60,6 @@ An *outdated* writeup of this project is also availabe at my `blog`_. .. _yowsup-2: http://github.com/stv0g/transwhat/tree/yowsup-2 .. _Installation: INSTALL.rst .. _Usage: USAGE.rst -.. _License: COPYING.rst +.. _GPLv3: COPYING.rst .. _here: https://dev.0l.de/wiki/projects/transwhat/ .. _blog: http://www.steffenvogel.de/2013/06/29/transwhat/