Add README and Crates.io metadata

Signed-off-by: trivernis <trivernis@protonmail.com>
pull/2/head
trivernis 3 years ago
parent 47b1202056
commit e2c97a8272
Signed by: Trivernis
GPG Key ID: DFFFCC2C7A02DB45

@ -3,6 +3,10 @@ name = "hydrus-api"
version = "0.1.0" version = "0.1.0"
authors = ["trivernis <trivernis@protonmail.com>"] authors = ["trivernis <trivernis@protonmail.com>"]
edition = "2018" edition = "2018"
license = "Apache-2.0"
readme = "README.md"
description = "A rust wrapper for the hydrus client api"
repository = "https://github.com/trivernis/hydrus-api-rs"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

@ -0,0 +1,36 @@
# Hydrus Rust API
This is a WIP Rust Wrapper for the Hydrus Client API.
The official API documentation can be found [here](https://hydrusnetwork.github.io/hydrus/help/client_api.html).
## Example
```rust
use hydrus_api_rs::Client;
#[tokio::main]
async fn main() {
Client::new(
env::var("HYDRUS_URL").unwrap(),
env::var("HYDRUS_ACCESS_KEY").unwrap(),
).unwrap();
// let's first import a file
let hash = client.add_file("/path/to/my/file").await.unwrap().hash;
// and now let's add tags to it
let request = AddTagsRequestBuilder::default()
.add_hash(hash)
// for each tag the service has to be specified
.add_tags("my tags", vec!["beach".into(), "summer".into()])
// with tag actions tags can also be removed. It's especially useful for the PTR
.add_tag_with_action("my tags", "rain", TagAction::DeleteFromLocalService)
.build();
client.add_tags(request).await.unwrap();
}
```
## License
Apache-2.0

@ -5,3 +5,5 @@ pub mod client;
mod error; mod error;
pub mod paths; pub mod paths;
pub(crate) mod utils; pub(crate) mod utils;
pub use client::Client;

@ -1,5 +1,4 @@
use hydrus_api::paths::adding_tags::{AddTagsRequestBuilder, TagAction}; use hydrus_api::paths::adding_tags::{AddTagsRequestBuilder, TagAction};
mod common; mod common;
#[tokio::test] #[tokio::test]

Loading…
Cancel
Save