Explorar el Código

Replace wiki with docs.mau.fi

Tulir Asokan hace 4 años
padre
commit
ebf2072025
Se han modificado 1 ficheros con 11 adiciones y 2 borrados
  1. 11 2
      README.md

+ 11 - 2
README.md

@@ -2,9 +2,18 @@
 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.
 
-### [Wiki](https://github.com/tulir/mautrix-whatsapp/wiki)
+### Documentation
+All setup and usage instructions are located on
+[docs.mau.fi](https://docs.mau.fi/bridges/go/whatsapp/index.html).
+Some quick links:
 
-### [Features & Roadmap](https://github.com/tulir/mautrix-whatsapp/blob/master/ROADMAP.md)
+* [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)