Fix docs link

This commit is contained in:
Igor Katson 2023-11-16 07:39:49 +00:00
parent 62ed868208
commit da3e6abc5a
No known key found for this signature in database
GPG key ID: B4EC22B66D61A3F5
3 changed files with 3 additions and 41 deletions

View file

@ -4,6 +4,8 @@ version = "2.2.1"
edition = "2018"
description = "Util traits to represent something that can be made owned and change type at the same time."
license = "Apache-2.0"
documentation = "https://docs.rs/librqbit-clone-to-owned"
readme = "README.md"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

View file

@ -5,7 +5,7 @@ authors = ["Igor Katson <igor.katson@gmail.com>"]
edition = "2018"
description = "The main library used by rqbit torrent client. The binary is just a small wrapper on top of it."
license = "Apache-2.0"
documentation = "https://docs.rs/librqbit-dht"
documentation = "https://docs.rs/librqbit"
repository = "https://github.com/ikatson/rqbit"
readme = "README.md"

View file

@ -1,40 +0,0 @@
# librqbit
A torrent library 100% written in rust
## Basic example
This is a simple program on how to use this library
This program will just download a simple torrent file with a Magnet link
```rust
use std::error::Error;
use std::path::PathBuf;
use librqbit::session::{AddTorrentResponse, Session};
use librqbit::spawn_utils::BlockingSpawner;
const MAGNET_LINK: &str = "magnet:?..."; // Put your magnet link here
#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>>{
// Create the session
let session = Session::new("C:\\Anime".parse().unwrap(), BlockingSpawner::new(false)).await?;
// Add the torrent to the session
let handle = match session.add_torrent(MAGNET_LINK, None).await {
Ok(AddTorrentResponse::Added(handle)) => {
Ok(handle)
},
Err(e) => {
eprintln!("Something goes wrong when downloading torrent : {:?}", e);
Err(())
}
_ => Err(())
}.expect("Failed to add torrent to the session");
// Wait until the download is completed
handle.wait_until_completed().await?;
Ok(())
}
```