1
Fork 0

Add the readme.

This commit is contained in:
Bauke 2022-04-02 14:33:36 +02:00
parent 2527cb1474
commit 508b434eb7
Signed by: Bauke
GPG Key ID: C1C0F29952BCF558
1 changed files with 28 additions and 0 deletions

28
README.md Normal file
View File

@ -0,0 +1,28 @@
# gravatar-rs
> Gravatar image URL library
## API
For full documentation see [docs.rs].
[docs.rs]: https://docs.rs/gravatar-rs
```rust
use gravatar_rs::Generator;
let generator = Generator::default();
let gravatar_url = generator.generate("helllo@holllo.cc");
assert_eq!(
gravatar_url,
"https://www.gravatar.com/avatar/ebff9105dce4954b1bdb57fdab079ff3"
);
```
## License
This project is licensed under either of [Apache License, Version 2.0](https://github.com/Holllo/gravatar-rs/blob/main/LICENSE-Apache) or [MIT license](https://github.com/Holllo/gravatar-rs/blob/main/LICENSE-MIT) at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in either crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.