docs(readme): add readme

2 files changed, 28 insertions, 1 deletions

diff --git a/Cargo.toml b/Cargo.toml
index efef0fb..bd88e1d 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -5,7 +5,7 @@ name = "windmark"
 version = "0.0.0"
 authors = ["Fuwn <[email protected]>"]
 edition = "2021"
-description = "Simple and highly performant Gemini server framework"
+description = "A simple and highly performant Gemini server framework"
 documentation = "https://docs.rs/windmark"
 readme = "README.md"
 homepage = "https://github.com/gemrest/windmark"
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..92026be
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# Windmark
+
+[![crates.io](https://img.shields.io/crates/v/windmark.svg)](https://crates.io/crates/windmark)
+[![docs.rs](https://docs.rs/windmark/badge.svg)](https://docs.rs/windmark)
+[![github.com](https://github.com/gemrest/windmark/actions/workflows/check.yaml/badge.svg?branch=main)](https://github.com/gemrest/windmark/actions/workflows/check.yaml)
+
+Windmark is a simple and highly performant Gemini server framework.
+
+## Usage
+
+```toml
+# Cargo.toml
+
+[dependencies]
+windmark = "0.1.0"
+
+# If you would like to use the built-in logger (reccomended)
+# windmark = { version = "0.1.0", features = ["logger"] }
+```
+
+## Examples
+
+Examples can be found within the [`examples/`](./examples) directory.
+
+## License
+
+This project is licensed with the [GNU General Public License v3.0](./LICENSE).