noham/TransmissionBot
1
0
Fork 0
mirror of https://github.com/NohamR/TransmissionBot.git synced 2025-05-24 14:22:00 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
updated to reflect completed todo items
This commit is contained in:
Tim Wilson 2020-08-25 11:56:12 -06:00 committed by GitHub
parent 4d0e3d6854
commit 9e4d64c27b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -11,8 +11,9 @@ This bot is built on [kkrypt0nn's bot template](https://github.com/kkrypt0nn/Pyt
* Complete management of transfers:
* `t/add URL` Add new torrent transfers via **URL to torrent file** or **magnet link**
* `t/list [OPTIONS]` List existing transfers with filtering, sorting, and searching transfer names with regular expressions
* `t/modify [OPTIONS]` Modify (pause, resume, remove, or remove and delete) transfer(s) by transfer ID(s) or using `list` options
* `t/modify [OPTIONS]` Modify (pause, resume, remove, remove and delete, or verify data) transfer(s) by transfer ID(s) or using `list` options
* `t/summary` Print simple summary of all transfers
* Auto-update output for `summary` and `list` commands
* In-channel documentation using `t/help [COMMAND]`
## Example images
@ -60,13 +61,13 @@ This bot is built on [kkrypt0nn's bot template](https://github.com/kkrypt0nn/Pyt
* Command to print detailed information for transfer(s)
* Complete connection information
* Lists of transfer files, peers, trackers
* Add ability to verify transfer data
* ~~Add ability to verify transfer data~~
* When searching by name, update regex to include potential accented characters, eg `pokemon` would also match `pokémon`
* Specify number of transfers to show when using `list` or `modify`
* Combine the `list` and `modify` commands in the code, with a simple parameter to specify whether or not modification is allowed
* Currently, searching by name is done with case-insensitive regex. Update to that if a user includes upper case characters, case-sensitive search is performed
* Add recurring list option. Ie every five seconds replace `list` output with fresh output. This would be done by reacting to a "repeat" emoji to initiate repetition of the current search
* Add additional filtering options: stalled, error, non-zero up/down rate.
* ~~Add recurring list option. Ie every five seconds replace `list` output with fresh output. This would be done by reacting to a "repeat" emoji to initiate repetition of the current search~~ (also did this for `summary`)
* ~~Add additional filtering options: stalled, error, non-zero up/down rate.~~
* Add shorthand for filtering options (downloading/seeding/stalled/paused become d/s/i/p etc., that's i for "idle" since s is for seeding)
* Add a `top` command that'sessentially a combination of the up/down rate filter and the repeating output features
* Ability to refine `list` output with filter or sort using reactions; ie click a filter or sort reaction which triggers another message with additional reactions to click to apply the extra filters or sort