🏗️ Elegant & Highly Performant Async Gemini Server Framework for the Modern Age
async
framework
gemini-protocol
protocol
gemini
rust
docs(readme): extend useful sections
+11
-15
+11
-15
README.md
+11
-15
README.md
···
47
47
# windmark = { version = "0.3.9", features = ["response-macros"] }
48
48
```
49
49
50
-
### Implement a Windmark server
50
+
### Implementing a Windmark Server
51
51
52
52
```rust
53
53
// src/main.rs
···
68
68
}
69
69
```
70
70
71
-
### Implement a Windmark server using Rossweisse
71
+
### Implementing a Windmark Server Using Rossweisse
72
72
73
73
```rust
74
74
// src/main.rs
···
97
97
[`examples/`](https://github.com/gemrest/windmark/tree/main/examples) directory
98
98
along with a rundown of each of their purposes and useful facts.
99
99
100
-
An example of a fully featured Gemini capsule written using Windmark can be
101
-
found [here](https://github.com/gemrest/locus). This example Gemini capsule also
102
-
happens to be the source code for [Fuwn's](https://github.com/Fuwn) (this
103
-
library's author) personal Gemini capsule!
100
+
Run an example by cloning this repository and running `cargo run --example example_name`.
104
101
105
102
## Modules
106
103
107
-
Modules are reusable extensions which can be procedurally mounted onto Windmark
104
+
Modules are composable extensions which can be procedurally mounted onto Windmark
108
105
routers.
109
106
110
-
[Add yours!](https://github.com/gemrest/windmark/edit/main/README.md)
111
-
112
-
- [Windmark Comments](https://github.com/gemrest/windmark-comments)
107
+
### Examples
113
108
114
-
## Capsules using Windmark
115
-
116
-
[Add yours!](https://github.com/gemrest/windmark/edit/main/README.md)
117
-
118
-
- <https://fuwn.me/>
109
+
- [Simple Stateless Module](https://github.com/gemrest/windmark/blob/main/examples/stateless_module.rs)
110
+
\- Mounts the `/smiley` route, returning an 😀 emoji
111
+
- [Simple Stateful Module](https://github.com/gemrest/windmark/blob/main/examples/stateful_module.rs)
112
+
\- Adds a click tracker (route hit tracker) that additionally notifies before and after route visits
113
+
- [Windmark Comments](https://github.com/gemrest/windmark-comments) - A fully featured comment engine
114
+
for your capsule
119
115
120
116
## License
121
117