diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..b5bd6f6 --- /dev/null +++ b/README.rst @@ -0,0 +1,46 @@ +# transWhat + +transWhat is a WhatsApp XMPP Gateway based on [Spectrum 2](http://www.spectrum.im) and [Yowsup 2](https://github.com/tgalal/yowsup). + +#### 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`. + +For production, please use the `yowsup-2` branch. + +Please file bugreports against the `develop` branch. + +## [Installation](INSTALL.md) +## [Usage](USAGE.md) + +## Features + + * Typing notifications + * Receive images, audio & video + * Set/get online status + * Set status message + * Groupchats + +## Contributors + +Pull requests, bug reports etc. are welcome. Help us to provide a open implementation of the WhatsApp protocol. + +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 + +## [License](COPYING.md) + +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. + +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 + +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](http://www.steffenvogel.de/2013/06/29/transwhat/).