Rewrite readme.
This commit is contained in:
parent
72fd56f313
commit
a73c981a82
20
README.md
20
README.md
|
@ -1,28 +1,30 @@
|
||||||
# gravatar-rs
|
# Gravatar 📇 Rust
|
||||||
|
|
||||||
> Gravatar image URL library
|
> **Gravatar image URL library for Rust.**
|
||||||
|
|
||||||
## API
|
## API
|
||||||
|
|
||||||
For full documentation see [docs.rs].
|
For full documentation see [docs.rs](https://docs.rs/gravatar-rs).
|
||||||
|
|
||||||
[docs.rs]: https://docs.rs/gravatar-rs
|
## Example
|
||||||
|
|
||||||
```rust
|
```rust
|
||||||
use gravatar_rs::Generator;
|
use gravatar_rs::Generator;
|
||||||
|
|
||||||
let generator = Generator::default();
|
let generator = Generator::default();
|
||||||
|
|
||||||
let gravatar_url = generator.generate("helllo@holllo.cc");
|
let gravatar_url = generator.generate("helllo@holllo.org");
|
||||||
|
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
gravatar_url,
|
gravatar_url,
|
||||||
"https://www.gravatar.com/avatar/ebff9105dce4954b1bdb57fdab079ff3"
|
"https://www.gravatar.com/avatar/e9a2c03d607ec80a5b725ad42c19ee36"
|
||||||
);
|
);
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Feedback
|
||||||
|
|
||||||
|
Found a problem or want to request a new feature? Email [helllo@holllo.org](mailto:helllo@holllo.org) and I'll see what I can do for you.
|
||||||
|
|
||||||
## License
|
## 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.
|
Distributed under the [Apache License 2.0](https://spdx.org/licenses/Apache-2.0.html) and [MIT](https://spdx.org/licenses/MIT.html) licenses, see [LICENSE-Apache](https://git.bauke.xyz/Holllo/gravatar-rs/src/branch/main/LICENSE-Apache) and [LICENSE-MIT](https://git.bauke.xyz/Holllo/gravatar-rs/src/branch/main/LICENSE-MIT) for more information.
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
Loading…
Reference in New Issue