diff --git a/README.md b/README.md index fa38fe745..beab83e4e 100644 --- a/README.md +++ b/README.md @@ -2,29 +2,29 @@ [![crates.io](https://img.shields.io/crates/v/librqbit.svg)](https://crates.io/crates/librqbit) [![docs.rs](https://img.shields.io/docsrs/librqbit.svg)](https://docs.rs/librqbit/latest/librqbit/) -# rqbit - bittorrent client in Rust +# rqbit - BitTorrent client in Rust -**rqbit** is a bittorrent client written in Rust. Has HTTP API and Web UI, and can be used as a library. +**rqbit** is a BitTorrent client written in Rust. It has an HTTP API and a Web UI, and can be used as a library. -Also has a desktop app built with [Tauri](https://tauri.app/). +rqbit also has a desktop app built with [Tauri](https://tauri.app/). ## Usage quick start ### Optional - start the server -Assuming you are downloading to ~/Downloads. +Assuming you are downloading to ~/Downloads: rqbit server start ~/Downloads ### Download torrents -Assuming you are downloading to ~/Downloads. By default it'll download to current directory. +Assuming you are downloading to ~/Downloads. By default it'll download to current directory: rqbit download [-o ~/Downloads] 'magnet:?....' [https?://url/to/.torrent] [/path/to/local/file.torrent] ## Web UI -Access at http://localhost:3030/web/. See screenshot below (torrent names and speeds are simulated). +The Web UI can be accessed at http://localhost:3030/web/. See screenshot below (torrent names and speeds are simulated). @@ -32,7 +32,7 @@ Access at http://localhost:3030/web/. See screenshot below (torrent names and sp The desktop app is a [thin wrapper](https://github.com/ikatson/rqbit/blob/main/desktop/src-tauri/src/main.rs) on top of the Web UI frontend. -Download it in [Releases](https://github.com/ikatson/rqbit/releases) for OSX and Windows. For Linux, build manually with +Download it at [Releases](https://github.com/ikatson/rqbit/releases) for OSX and Windows. For Linux, build manually with cargo tauri build @@ -49,7 +49,7 @@ The streaming URLs look like http://IP:3030/torrents//stream/