kopia lustrzana https://github.com/mate-dev/meshtastic-matrix-relay
Documentation updates
rodzic
d0a2083090
commit
eefddab1a9
32
README.md
32
README.md
|
@ -13,11 +13,17 @@ A powerful and easy-to-use relay between Meshtastic devices and Matrix chat room
|
|||
- SQLite database to store node information for improved functionality
|
||||
- Customizable logging level for easy debugging
|
||||
- Configurable through a simple YAML file
|
||||
- **New:** Supports mapping multiple rooms and channels 1:1
|
||||
- Supports mapping multiple rooms and channels 1:1
|
||||
- Relays messages to/from a MQTT broker, if configured in the Meshtastic firmware (*Note: Messages relayed via MQTT currently share the relay's `meshnet_name`*)
|
||||
|
||||
|
||||
*We would love to support [Matrix E2EE rooms](https://github.com/geoffwhittington/meshtastic-matrix-relay/issues/33), but this is currently not implemented. If you are familiar with [matrix-nio](https://github.com/poljar/matrix-nio/), we would gladly accept a PR for this feature!*
|
||||
|
||||
|
||||
|
||||
### Windows Installer
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/1770544/235249050-8c79107a-50cc-4803-b989-39e58100342d.png" width="500"/>
|
||||
<img src="https://user-images.githubusercontent.com/1770544/235249050-8c79107a-50cc-4803-b989-39e58100342d.png" width="500"/>
|
||||
|
||||
The latest installer is available [here](https://github.com/geoffwhittington/meshtastic-matrix-relay/releases)
|
||||
|
||||
|
@ -25,18 +31,32 @@ The latest installer is available [here](https://github.com/geoffwhittington/mes
|
|||
|
||||
Generate a map of your nodes
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/1770544/235247915-47750b4f-d505-4792-a458-54a5f24c1523.png" width="500"/>
|
||||
<img src="https://user-images.githubusercontent.com/1770544/235247915-47750b4f-d505-4792-a458-54a5f24c1523.png" width="500"/>
|
||||
|
||||
Produce high-level details about your mesh
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/1770544/235245873-1ddc773b-a4cd-4c67-b0a5-b55a29504b73.png" width="500"/>
|
||||
<img src="https://user-images.githubusercontent.com/1770544/235245873-1ddc773b-a4cd-4c67-b0a5-b55a29504b73.png" width="500"/>
|
||||
|
||||
## Getting Started with Matrix
|
||||
|
||||
See our Wiki page [Getting Started With Matrix & MM Relay](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki/Getting-Started-With-Matrix-&-MM-Relay).
|
||||
|
||||
## Already on Matrix?
|
||||
|
||||
Join us!
|
||||
|
||||
- In our project's room:
|
||||
[#mmrelay:matrix.org](https://matrix.to/#/#mmrelay:matrix.org)
|
||||
|
||||
- Which is a part of the Meshtastic Community Matrix space *(an unofficial group of enthusiasts)*:
|
||||
[#meshtastic-community:matrix.org](https://matrix.to/#/#meshtastic-community:matrix.org)
|
||||
|
||||
## Supported Platforms
|
||||
|
||||
The relay can run on:
|
||||
The relay is compatible with the following operating systems:
|
||||
|
||||
- Linux
|
||||
- MacOS
|
||||
- Windows
|
||||
|
||||
Refer to [the development instructions](DEVELOPMENT.md) for more details.
|
||||
Refer to [the development instructions](DEVELOPMENT.md) for details about running the relay on MacOS and Linux.
|
||||
|
|
Ładowanie…
Reference in New Issue