mautrix-whatsapp/README.md
2021-02-14 14:00:03 +02:00

19 lines
899 B
Markdown

# mautrix-whatsapp
A Matrix-WhatsApp puppeting bridge based on the [Rhymen/go-whatsapp](https://github.com/Rhymen/go-whatsapp)
implementation of the [sigalor/whatsapp-web-reveng](https://github.com/sigalor/whatsapp-web-reveng) project.
### Documentation
All setup and usage instructions are located on
[docs.mau.fi](https://docs.mau.fi/bridges/go/whatsapp/index.html).
Some quick links:
* [Bridge setup](https://docs.mau.fi/bridges/go/whatsapp/setup/index.html)
(or [with Docker](https://docs.mau.fi/bridges/go/whatsapp/setup/docker.html))
* Basic usage: [Authentication](https://docs.mau.fi/bridges/go/whatsapp/authentication.html)
### Features & Roadmap
[ROADMAP.md](https://github.com/tulir/mautrix-whatsapp/blob/master/ROADMAP.md)
contains a general overview of what is supported by the bridge.
## Discussion
Matrix room: [#whatsapp:maunium.net](https://matrix.to/#/#whatsapp:maunium.net)