Update README

This commit is contained in:
a3x 2020-06-26 10:07:48 +00:00
parent d022243f6c
commit 5975c3d511
1 changed files with 4 additions and 33 deletions

View File

@ -1,7 +1,6 @@
transWhat
transpub
=========
transWhat is a WhatsApp XMPP Gateway based on `Spectrum 2`_ and `Yowsup 3`_.
Support
-------
@ -11,11 +10,11 @@ For support and discussions please join the XMPP MUC: **transwhat@conference.0l.
Features
--------
- Typing notifications
- Receive images, audio & video
- notifications
- Receive data on pubsub extension xep
- Set/get online status
- Set status message
- Groupchats
Installation
------------
@ -28,30 +27,8 @@ Users find details on the `Usage`_ page.
Branches
--------
- `yowsup-1`_ My original version which is based on @tgalal first
Yowsup version (**deprecated** and broken).
- `yowsup-2`_ Major rewrite from @moyamo for @tgalals new Yowsup 2.
- `yowsup-3`_ Update to @tgalals new Yowsup 3
(**recommended**).
For production, please use the ``yowsup-2`` branch.
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
-------
transWhat is licensed under the GPLv3_ license.
Links
-----
@ -60,12 +37,6 @@ Links
- An *outdated* writeup of this project is also availabe at my `blog`_.
.. _Spectrum 2: http://www.spectrum.im
.. _Yowsup 3: 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
.. _yowsup-3: http://github.com/stv0g/transwhat/tree/yowsup-3
.. _Installation: INSTALL.rst
.. _Usage: USAGE.rst
.. _GPLv3: COPYING.rst
.. _here: https://dev.0l.de/wiki/projects/transwhat/
.. _blog: http://www.steffenvogel.de/2013/06/29/transwhat/