Fix librqbit readme
This commit is contained in:
parent
da3e6abc5a
commit
c10f4fcd1b
2 changed files with 47 additions and 0 deletions
40
crates/librqbit/README.md
Normal file
40
crates/librqbit/README.md
Normal file
|
|
@ -0,0 +1,40 @@
|
||||||
|
# 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(())
|
||||||
|
}
|
||||||
|
```
|
||||||
7
scripts/publish.sh
Executable file
7
scripts/publish.sh
Executable file
|
|
@ -0,0 +1,7 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
find crates -maxdepth 1 -type d | grep '/' | while read dir; do
|
||||||
|
pushd "${dir}"
|
||||||
|
cargo publish --dry-run
|
||||||
|
popd
|
||||||
|
done
|
||||||
Loading…
Add table
Add a link
Reference in a new issue