From acee97bae82be05337facfbdb18c84143dbc2dc0 Mon Sep 17 00:00:00 2001 From: Fuwn Date: Sat, 26 Mar 2022 09:58:58 +0000 Subject: docs(readme): add readme --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md (limited to 'README.md') 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). -- cgit v1.2.3