From 3bfd8a615b03b9259d1398eb3cba74c9008ec583 Mon Sep 17 00:00:00 2001 From: micielski <73398428+micielski@users.noreply.github.com> Date: Fri, 6 Sep 2024 17:52:52 +0200 Subject: [PATCH] docs(readme): update config and shorten the description --- README.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b48c3f9..b91e94a 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,15 @@ **Rustmission** -Performant TUI client for Transmission daemon capable of managing hundreds of torrents. -It boasts a rich feature set that surpasses many other clients, offering a seamless torrenting experience :3 +Performant TUI for Transmission capable of managing hundreds of torrents. +It boasts a rich feature set that surpasses other clients, offering a seamless experience :3 #

- ⚠️ Torrents you see are just samples fabricated by AI. Piracy is not something we tolerate here at Intuis. + ⚠️ Torrents you see are just samples fabricated by AI.

@@ -23,7 +23,7 @@ It boasts a rich feature set that surpasses many other clients, offering a seaml ## Requirements -- Running [Transmission](https://github.com/transmission/transmission) daemon and its IP address +- Running [Transmission](https://github.com/transmission/transmission) daemon in background and its IP address - [Nerd Fonts](https://www.nerdfonts.com/) ## Installation @@ -91,12 +91,21 @@ free_space_refresh = 10 # Available fields: # Id, Name, SizeWhenDone, Progress, DownloadRate, UploadRate, DownloadDir, # Padding, UploadRatio, UploadedEver, AddedDate, ActivityDate, PeersConnected -# SmallStatus -headers = ["Name", "SizeWhenDone", "Progress", "DownloadRate", "UploadRate"] +# SmallStatus, Category, CategoryIcon +headers = ["Name", "SizeWhenDone", "Progress", "Eta", "DownloadRate", "UploadRate"] + +[search_tab] +# If you uncomment this, providers won't be automatically added in future +# versions of Rustmission. +# providers = ["Knaben", "Nyaa"] + +[icons] +# ... ``` -There's also a self-documenting keymap config located at `~/.config/rustmission/keymap.toml` with sane defaults. +There's also a self-documenting keymap config located at `~/.config/rustmission/keymap.toml` with sane defaults. +You can also define torrent categories at `~/.config/rustmission/categories.toml`. ## Alternatives - [Transgression](https://github.com/PanAeon/transg-tui)