From 508b434eb7dff9a395064f853e664d20decc604b Mon Sep 17 00:00:00 2001
From: Bauke <me@bauke.xyz>
Date: Sat, 2 Apr 2022 14:33:36 +0200
Subject: [PATCH] Add the readme.

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2a1f403
--- /dev/null
+++ b/README.md
@@ -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.