Forráskód Böngészése

Replace wiki with docs.mau.fi

Tulir Asokan 4 éve
szülő
commit
f066a698bb
1 módosított fájl, 11 hozzáadás és 2 törlés
  1. 11 2
      README.md

+ 11 - 2
README.md

@@ -6,9 +6,18 @@
 
 A Matrix-Signal puppeting bridge.
 
-### [Wiki](https://github.com/tulir/mautrix-signal/wiki)
+## Documentation
+All setup and usage instructions are located on
+[docs.mau.fi](https://docs.mau.fi/bridges/python/signal/index.html).
+Some quick links:
 
-### [Features & Roadmap](https://github.com/tulir/mautrix-signal/blob/master/ROADMAP.md)
+* [Bridge setup](https://docs.mau.fi/bridges/python/setup/index.html?bridge=signal)
+  (or [with Docker](https://docs.mau.fi/bridges/python/signal/setup-docker.html))
+* Basic usage: [Authentication](https://docs.mau.fi/bridges/python/signal/authentication.html)
+
+### Features & Roadmap
+[ROADMAP.md](https://github.com/tulir/mautrix-signal/blob/master/ROADMAP.md)
+contains a general overview of what is supported by the bridge.
 
 ## Discussion
 Matrix room: [`#signal:maunium.net`](https://matrix.to/#/#signal:maunium.net)