mautrix-whatsapp/README.md
2022-11-18 14:46:24 +02:00

18 lines
796 B
Markdown

# mautrix-whatsapp
A Matrix-WhatsApp puppeting bridge based on [whatsmeow](https://github.com/tulir/whatsmeow).
## Documentation
All setup and usage instructions are located on [docs.mau.fi]. Some quick links:
[docs.mau.fi]: https://docs.mau.fi/bridges/go/whatsapp/index.html
* [Bridge setup](https://docs.mau.fi/bridges/go/setup.html?bridge=whatsapp)
(or [with Docker](https://docs.mau.fi/bridges/general/docker-setup.html?bridge=whatsapp))
* Basic usage: [Authentication](https://docs.mau.fi/bridges/go/whatsapp/authentication.html)
### Features & Roadmap
[ROADMAP.md](https://github.com/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)