Update README

This commit is contained in:
Igor Katson 2023-11-27 09:41:54 +00:00
parent 25189ce161
commit 1a5716a734
No known key found for this signature in database
GPG key ID: B4EC22B66D61A3F5
2 changed files with 21 additions and 20 deletions

View file

@ -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/
<img width="995" alt="Screenshot 2023-11-27 at 09 30 10" src="https://github.com/ikatson/rqbit/assets/221386/d9403763-d162-492b-a718-a857ef4dd1e6">
## 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 <log-level>
@ -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/
<img width="995" alt="Screenshot 2023-11-27 at 09 30 10" src="https://github.com/ikatson/rqbit/assets/221386/d9403763-d162-492b-a718-a857ef4dd1e6">
## Code organization
- crates/rqbit - main binary
- crates/librqbit - main library