diff options
| author | Fuwn <[email protected]> | 2023-05-05 01:59:47 +0000 |
|---|---|---|
| committer | Fuwn <[email protected]> | 2023-05-05 01:59:47 +0000 |
| commit | c6ee82a58e4aaecc965215f8df50164c093d5f58 (patch) | |
| tree | ebb5221cbb41fa96c13c95baa1edf0b9289e4ff1 | |
| parent | docs(router): ignore attach_async example (diff) | |
| download | windmark-c6ee82a58e4aaecc965215f8df50164c093d5f58.tar.xz windmark-c6ee82a58e4aaecc965215f8df50164c093d5f58.zip | |
docs(readme): add feature flag table
| -rw-r--r-- | README.md | 12 |
1 files changed, 12 insertions, 0 deletions
@@ -15,6 +15,18 @@ A macro-based "`struct`-router" is currently being developed for Windmark. A subset of Windmark's features are currently available for use through it. Check out [Rossweisse](./rossweisse/) for more information! +### Features + +| Feature | Description | +| - | - | +| `default` | Base Windmark framework using [Tokio](https://tokio.rs/) | +| `logger` | Enables the default [`pretty_env_logger`](https://github.com/seanmonstar/pretty-env-logger) integration | +| `auto-deduce-mime` | Exposes `Response`s and macros that automatically fill MIMEs for non-Gemini responses | +| `response-macros` | Simple macros for all `Response`s | +| `tokio` | Marks [Tokio](https://tokio.rs/) as the asynchronous runtime | +| `async-std` | Marks [`async-std`](https://async.rs/) as the asynchronous runtime | +| `prelude` | Exposes the `prelude` module containing the most used Windmark features | + ### Add Windmark and Tokio as Dependencies ```toml |