Add README and Crates.io metadata

Signed-off-by: trivernis <trivernis@protonmail.com>
main
trivernis 4 years ago
parent e8dfb4e4ce
commit 2ba3cf4cd1
Signed by: Trivernis
GPG Key ID: DFFFCC2C7A02DB45

@ -3,6 +3,10 @@ name = "xkcd-search"
version = "0.1.0" version = "0.1.0"
authors = ["trivernis <trivernis@protonmail.com>"] authors = ["trivernis <trivernis@protonmail.com>"]
edition = "2018" edition = "2018"
readme = "README.md"
repository = "https://github.com/Trivernis/xkcd-search-rs"
description = "Search for xkcd comics and retrieve metadata"
license = "Apache-2.0"
# 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,23 @@
# XKCD Search
This crate provides functions to search for xkcd comics by title.
## Usage
```rust
use xkcd_search;
#[tokio::main]
async fn main() {
let phone_entries = xkcd_search::search("Phone").await.unwrap();
let mut comics = Vec::new();
for (_title, id) in phone_entries {
comics.push(xkcd_search::get_comic(id).await.unwrap())
}
}
```
## License
Apache-2.0
Loading…
Cancel
Save