2017-02-11 19:45:00 +00:00
|
|
|
|
transWhat
|
|
|
|
|
|
=========
|
2016-12-04 13:25:47 +00:00
|
|
|
|
|
2019-04-25 17:23:08 +00:00
|
|
|
|
transWhat is a WhatsApp XMPP Gateway based on `Spectrum 2`_ and `Yowsup 3`_.
|
2016-12-04 13:25:47 +00:00
|
|
|
|
|
2017-10-30 14:04:35 +00:00
|
|
|
|
Support
|
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
|
|
For support and discussions please join the XMPP MUC: **transwhat@conference.0l.de**.
|
|
|
|
|
|
|
|
|
|
|
|
Features
|
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
|
|
- Typing notifications
|
|
|
|
|
|
- Receive images, audio & video
|
|
|
|
|
|
- Set/get online status
|
|
|
|
|
|
- Set status message
|
|
|
|
|
|
- Groupchats
|
|
|
|
|
|
|
2017-10-29 19:18:57 +00:00
|
|
|
|
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.
|
|
|
|
|
|
|
2017-02-11 19:45:00 +00:00
|
|
|
|
Branches
|
2017-10-29 19:18:57 +00:00
|
|
|
|
--------
|
2016-12-04 13:25:47 +00:00
|
|
|
|
|
2017-02-11 19:45:00 +00:00
|
|
|
|
- `yowsup-1`_ My original version which is based on @tgalal first
|
|
|
|
|
|
Yowsup version (**deprecated** and broken).
|
2019-04-25 17:23:08 +00:00
|
|
|
|
- `yowsup-2`_ Major rewrite from @moyamo for @tgalal’s new Yowsup 2.
|
|
|
|
|
|
- `yowsup-3`_ Update to @tgalal’s new Yowsup 3
|
2017-02-11 19:45:00 +00:00
|
|
|
|
(**recommended**).
|
|
|
|
|
|
For production, please use the ``yowsup-2`` branch.
|
2016-12-04 13:25:47 +00:00
|
|
|
|
|
2017-02-11 19:45:00 +00:00
|
|
|
|
Contributors
|
|
|
|
|
|
------------
|
2016-12-04 13:25:47 +00:00
|
|
|
|
|
2017-02-11 19:45:00 +00:00
|
|
|
|
Pull requests, bug reports etc. are welcome. Help us to provide a open
|
|
|
|
|
|
implementation of the WhatsApp protocol.
|
2016-12-04 13:25:47 +00:00
|
|
|
|
|
2017-02-11 19:45:00 +00:00
|
|
|
|
The following persons have contributed major parts of this code:
|
2016-12-04 13:25:47 +00:00
|
|
|
|
|
2017-02-11 19:45:00 +00:00
|
|
|
|
- @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
|
2016-12-04 13:25:47 +00:00
|
|
|
|
|
2017-10-29 19:18:57 +00:00
|
|
|
|
License
|
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
|
|
transWhat is licensed under the GPLv3_ license.
|
|
|
|
|
|
|
2017-02-11 19:45:00 +00:00
|
|
|
|
Links
|
|
|
|
|
|
-----
|
2016-12-04 13:25:47 +00:00
|
|
|
|
|
2017-10-30 14:04:35 +00:00
|
|
|
|
- An *outdated* project wiki is available `here`_.
|
|
|
|
|
|
- An *outdated* writeup of this project is also availabe at my `blog`_.
|
2016-12-04 13:25:47 +00:00
|
|
|
|
|
2017-02-11 19:45:00 +00:00
|
|
|
|
.. _Spectrum 2: http://www.spectrum.im
|
2019-04-25 17:23:08 +00:00
|
|
|
|
.. _Yowsup 3: https://github.com/tgalal/yowsup
|
2017-02-11 19:45:00 +00:00
|
|
|
|
.. _yowsup-1: http://github.com/stv0g/transwhat/tree/yowsup-1
|
|
|
|
|
|
.. _yowsup-2: http://github.com/stv0g/transwhat/tree/yowsup-2
|
2019-04-25 17:23:08 +00:00
|
|
|
|
.. _yowsup-3: http://github.com/stv0g/transwhat/tree/yowsup-3
|
2017-02-11 19:45:00 +00:00
|
|
|
|
.. _Installation: INSTALL.rst
|
|
|
|
|
|
.. _Usage: USAGE.rst
|
2017-10-29 19:18:57 +00:00
|
|
|
|
.. _GPLv3: COPYING.rst
|
2017-02-11 19:45:00 +00:00
|
|
|
|
.. _here: https://dev.0l.de/wiki/projects/transwhat/
|
|
|
|
|
|
.. _blog: http://www.steffenvogel.de/2013/06/29/transwhat/
|
