Git-Mirrors/Sideband
1
0
Fork 0
mirror of https://github.com/markqvist/Sideband.git synced 2024-10-01 03:15:37 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated readme

Browse Source
This commit is contained in:
Mark Qvist 2024-06-07 18:46:20 +02:00
parent b2b316396b
commit bea87275e0
1 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -11,17 +11,17 @@ This also means that Sideband operates differently than what you might be used t
Sideband provides many useful and interesting functions, such as: Sideband provides many useful and interesting functions, such as:
- Secure and self-sovereign messaging using the LXMF protocol over Reticulum. - **Secure** and **self-sovereign** messaging using the LXMF protocol over Reticulum.
- Image and file transfers over all supported mediums. - **Image** and **file transfers** over all supported mediums.
- Audio messages that work even over LoRa and radio links, thanks to [Codec2](https://github.com/drowe67/codec2/) and [Opus](https://github.com/xiph/opus) encoding. - **Audio messages** that work even over **LoRa** and **radio links**, thanks to [Codec2](https://github.com/drowe67/codec2/) and [Opus](https://github.com/xiph/opus) encoding.
- Secure and direct P2P telemetry and location sharing. No third parties or servers ever have your data. - Secure and direct P2P **telemetry and location sharing**. No third parties or servers ever have your data.
- Situation display on both online and locally stored offline maps. - Situation display on both online and **locally stored offline maps**.
- Geospatial awareness calculations. - Geospatial awareness calculations.
- Exchanging messages through encrypted QR-codes on paper, or through messages embedded directly in **lxm://** links. - Exchanging messages through **encrypted QR-codes on paper**, or through messages embedded directly in **lxm://** links.
- Using Android devices as impromptu Reticulum routers (*Transport Instances*), for setting up or extending networks easily. - Using **Android devices as impromptu Reticulum routers** (*Transport Instances*), for setting up or extending networks easily.
- Remote command execution and response engine, with built-in commands, such as `ping`, `signal` reports and `echo`. - Remote **command execution and response engine**, with built-in commands, such as `ping`, `signal` reports and `echo`, and **full plug-ing expandability**.
- Remote telemetry querying, with strong, secure and cryptographically robust authentication and control. - Remote **telemetry querying**, with strong, secure and cryptographically robust authentication and control.
- Plugin system that allows you to easily create your own commands, services and telemetry sources. - **Plugin system** that allows you to easily **create your own commands**, services and telemetry sources.
Sideband is fully compatible with other LXMF clients, such as [MeshChat](https://github.com/liamcottle/reticulum-meshchat), and [Nomad Network](https://github.com/markqvist/nomadnet). The Nomad Network client also allows you to easily host Propagation Nodes for your LXMF network, and more. Sideband is fully compatible with other LXMF clients, such as [MeshChat](https://github.com/liamcottle/reticulum-meshchat), and [Nomad Network](https://github.com/markqvist/nomadnet). The Nomad Network client also allows you to easily host Propagation Nodes for your LXMF network, and more.
@ -51,6 +51,9 @@ sudo apt install python3-pyaudio xclip xsel # Debian and derivatives
# Install the Sideband application: # Install the Sideband application:
pip install sbapp pip install sbapp
# Or, if pip is externally managed:
pip install sbapp --break-system-packages
# If you intend to run Sideband in headless # If you intend to run Sideband in headless
# daemon mode, you can also install it without # daemon mode, you can also install it without
# any of the normal UI dependencies: # any of the normal UI dependencies: