README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
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).