From 35aa41f5bacd8841fe030ef558829d98d627e022 Mon Sep 17 00:00:00 2001 From: Rob Wagner Date: Mon, 23 Oct 2023 23:58:41 -0400 Subject: [PATCH] Update README.md --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7c587b7..7bdb487 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,22 @@ const values for all of the htmx headers, so there's no need to mess with strings in your handlers. +## Table of Contents + +- [axum-htmx](#axum-htmx) + - [Table of Contents](#table-of-contents) + - [Getting Started](#getting-started) + - [Extractors](#extractors) + - [Responders](#responders) + - [Request Guards](#request-guards) + - [Examples](#examples) + - [Example: Extractors](#example-extractors) + - [Example: Responders](#example-responders) + - [Example: Router Guard](#example-router-guard) + - [Feature Flags](#feature-flags) + - [Contributing](#contributing) + - [License](#license) + ## Getting Started Simply run `cargo add axum-htmx` to add the library to your project. @@ -86,6 +102,8 @@ trivially set the `HX-Request` header themselves. This is merely a convenience for preventing users from receiving partial responses without context. If you need to secure an endpoint you should be using a proper auth system._ +## Examples + ### Example: Extractors In this example, we'll look for the `HX-Boosted` header, which is set when @@ -175,7 +193,7 @@ fn router_two() -> Router { } ``` -### Feature Flags +## Feature Flags | Flag | Default | Description | Dependencies |