From 384f927fc36309a98ded4c8a609ed9a6d75ce960 Mon Sep 17 00:00:00 2001 From: Alexey <247128645+axkurcom@users.noreply.github.com> Date: Wed, 7 Jan 2026 19:06:28 +0300 Subject: [PATCH] Update README.md --- README.md | 46 ++++++++++++++++++++++++++++++---------------- 1 file changed, 30 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 6ef3bac..fda24b2 100644 --- a/README.md +++ b/README.md @@ -33,23 +33,20 @@ - Extensive logging via `trace` and `debug` with `RUST_LOG` method ## Quick Start Guide - -### Build +**This software is designed for Debian-based OS: in addition to Debian, these are Ubuntu, Mint, Kali, MX and many other Linux** +1. Download release ```bash -# Cloning repo -git clone https://github.com/telemt/telemt -# Changing Directory to telemt -cd telemt -# Starting Release Build -cargo build --release -# Move to /bin -mv ./target/release/telemt /bin -# Make executable -chmod +x /bin/telemt -# Lets go! -telemt config.toml +wget https://github.com/telemt/telemt/releases/latest/download/telemt ``` - +2. Move to Bin Folder +```bash +mv telemt /bin +``` +4. Make Executable +```bash +chmod +x /bin/telemt +``` +5. Go to [How to use?](#how-to-use) section for for further steps ## How to use? ### Telemt via Systemd **0. Check port and generate secrets** @@ -115,7 +112,7 @@ then Ctrl+X -> Y -> Enter to save ### Minimal Configuration for First Start ```toml port = 443 # Listening port -show_links = ["tele", "hello"] +show_links = ["tele", "hello"] # Specify users, for whom will be displayed the links [users] tele = "00000000000000000000000000000000" # Replace the secret with one generated before @@ -191,6 +188,23 @@ enabled = true - in Russia on mobile networks, less in wired networks - in Iran during "activity" + +## Build +```bash +# Cloning repo +git clone https://github.com/telemt/telemt +# Changing Directory to telemt +cd telemt +# Starting Release Build +cargo build --release +# Move to /bin +mv ./target/release/telemt /bin +# Make executable +chmod +x /bin/telemt +# Lets go! +telemt config.toml +``` + ## Why Rust? - Long-running reliability and idempotent behavior - Rust’s deterministic resource management - RAII