update + htmx

README.md

@@ -27,3 +27,19 @@ CREATE TABLE IF NOT EXISTS user_session (
     FOREIGN KEY("user") REFERENCES users(username)
 );
 ```
+
+## HTMX
+Based has a route for serving HTMX at `based::htmx::htmx_script_route` which you can include in your rocket `routes!`. The HTMX script will be available at `/assets/htmx.min.js`.
+
+Additionally you can check if a requests originates from HTMX:
+
+```rs
+#[get("/")]
+pub async fn index(ctx: RequestContext) -> StringRespopnse {
+    if ctx.is_htmx {
+        ...
+    } else {
+        ...
+    }
+}
+```