update readme

Author: vincentsarago

README.md

@@ -16,8 +16,6 @@
 
 ---
 
-**Documentation**:
-
 **Source Code**: <a href="https://github.com/developmentseed/stac-fastapi-html-middleware" target="_blank">https://github.com/developmentseed/stac-fastapi-html-middleware</a>
 
 ---
@@ -36,6 +34,36 @@ The `HTMLRenderMiddleware` is designed to intercept responses from stac-fastapi
 - the user set `f=html` query-parameter
 - `Accept: text/html` request's headers is the highest *priority*
 
+```bash
+# regular request - return JSON document
+$ curl http://127.0.0.1:8000 -s -D - -o /dev/null
+HTTP/1.1 200 OK
+date: Wed, 26 Mar 2025 11:16:18 GMT
+server: uvicorn
+content-length: 3001
+content-type: application/json
+
+# Ask for html with `Accept` header - return HTML document
+$ curl http://127.0.0.1:8000 -s -D - -o /dev/null -H 'accept: text/html'
+HTTP/1.1 200 OK
+date: Wed, 26 Mar 2025 11:15:38 GMT
+server: uvicorn
+content-length: 3560
+content-type: text/html
+
+# Ask for html with `f=html` QueryParameter - return HTML document
+$ curl http://127.0.0.1:8000\?f\=html -s -D - -o /dev/null
+HTTP/1.1 200 OK
+date: Wed, 26 Mar 2025 11:16:03 GMT
+server: uvicorn
+content-length: 3569
+content-type: text/html
+```
+
+This middleware will also intercept the openapi document from stac-fastapi application to enhance the schemas by adding `f=html` query-parameter and `Accept: text/html` available headers.
+
+<img width="800" alt="Screenshot 2025-03-25 at 3 16 44 PM" src="https://github.com/user-attachments/assets/07b53933-fbfd-4ba1-b654-6f2d72a2334b" />
+
 ## How
 
 ```python
@@ -51,6 +79,32 @@ api = StacApi(
 )
 ```
 
+:warning: You should place the `HTMLRenderMiddleware` before any `compression` middleware in the `middlewares` stack
+
+```python
+# NOK
+api = StacApi(
+    ...
+    middlewares=[
+        Middleware(BrotliMiddleware),
+        Middleware(HTMLRenderMiddleware),
+    ],
+)
+# OK
+api = StacApi(
+    ...
+    middlewares=[
+        Middleware(HTMLRenderMiddleware),  # <-- Put the HTML Render middleware before the compression middleware
+        Middleware(BrotliMiddleware),
+    ],
+)
+```
+
+## HTML documents
+
+See [docs/pages.md](docs/pages.md) for HTML preview
+
+
 ## Contribution & Development
 
 See [CONTRIBUTING.md](https://github.com/developmentseed/stac-fastapi-html-middleware/blob/main/CONTRIBUTING.md)

docs/img/collection.png

@@ -0,0 +1,24 @@
+
+### Landing
+![](img/landing.png)
+
+### Conformances
+![](img/conformance.png)
+
+### Queryables
+![](img/queryables.png)
+
+### Collections
+![](img/collections.png)
+
+### Collection
+![](img/collection.png)
+
+### Items Collection
+![](img/items.png)
+
+### Item
+![](img/item.png)
+
+### Search
+![](img/search.png)