diff --git a/README.md b/README.md index dd967f8..66efc60 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,26 @@ # rqbit - bittorrent client in Rust -**rqbit** is a bittorrent client written in Rust. +**rqbit** is a bittorrent client and server written in Rust. Has HTTP API and Web UI, and can be used as a library. + +## Usage quick start + +### Optional - start the server + +Assuming you are downloading to ~/Downloads. + + rqbit server start ~/Downloads + +### Download torrents + +Assuming you are downloading to ~/Downloads. If the server is already started, ```-o ~/Downloads``` can be omitted. + + rqbit download -o ~/Downloads 'magnet:?....' [https?://url/to/.torrent] [/path/to/local/file.torrent] + +## Web UI +Access with http://localhost:3030/web/ + +Screenshot 2023-11-27 at 09 30 10 ## Installation @@ -22,20 +41,6 @@ Just a regular Rust binary build process. cargo build --release -## Usage quick start - -### Optional - start the server - -Assuming you are downloading to ~/Downloads. - - rqbit server start ~/Downloads - -### Download torrents - -Assuming you are downloading to ~/Downloads. If the server is already started, ```-o ~/Downloads``` can be omitted. - - rqbit download -o ~/Downloads 'magnet:?....' [https?://url/to/.torrent] [/path/to/local/file.torrent] - ## Useful options ### -v @@ -118,11 +123,6 @@ Supported query parameters, all optional: - output_folder - the folder to download to. If not specified, defaults to the one that rqbit server started with - list_only=true|false - if you want to just list the files in the torrent instead of downloading -## Web UI -Access with http://localhost:3030/web/ - -Screenshot 2023-11-27 at 09 30 10 - ## Code organization - crates/rqbit - main binary - crates/librqbit - main library diff --git a/TODO.md b/TODO.md index 154b1eb..339c3ac 100644 --- a/TODO.md +++ b/TODO.md @@ -20,6 +20,7 @@ someday: - [x] cancellation from the client-side for the lib (i.e. stop the torrent manager) +- [ ] favicons for Web UI refactor: - [x] where are peers stored