readme

Author: vincentsarago

CHANGES.md

@@ -0,0 +1,16 @@
+# Release Notes
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/).
+
+Note: Minor version `0.X.0` update might break the API, It's recommended to pin `stac-fastapi-html` to minor version
+
+## [unreleased]
+
+## [0.1.0] - TBD
+
+- Initial release
+
+[unreleased]: https://github.com/developmentseed/stac-fastapi-html-middleware/compare/0.1.0...HEAD
+[0.1.0]: https://github.com/developmentseed/stac-fastapi-html-middleware/compare/e47f870114260acc70ac56c9632d41dbb267a4d0...0.1.0

CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Development - Contributing
+
+Issues and pull requests are more than welcome: https://github.com/developmentseed/stac-fastapi-html-middleware/issues
+
+**dev install**
+
+```bash
+git clone https://github.com/developmentseed/stac-fastapi-html-middleware.git
+cd stac-fastapi-html-middleware
+python -m pip install -e .["dev"]
+```
+
+You can then run the tests with the following command:
+
+```sh
+python -m pytest --cov stac-fastapi-html --cov-report term-missing --asyncio-mode=strict
+```
+
+**pre-commit**
+
+This repo is set to use `pre-commit` to run *isort*, *flake8*, *pydocstring*, *black* ("uncompromising Python code formatter") and mypy when committing new code.
+
+```bash
+# Install pre-commit command
+$ pip install pre-commit
+
+# Setup pre-commit withing your local environment
+$ pre-commit install
+```

README.md

@@ -1 +1,69 @@
 ## stac-fastapi HTML middleware
+
+<p align="center">
+  <img width="500" src="https://github.com/user-attachments/assets/f243a238-5ba7-44da-963a-cd865578c2a5"/>
+  <p align="center">stac-fastapi middleware to encode responses into HTML documents</p>
+</p>
+<p align="center">
+  <a href="https://github.com/developmentseed/stac-fastapi-html-middleware/actions?query=workflow%3ACI" target="_blank">
+      <img src="https://github.com/developmentseed/stac-fastapi-html-middleware/workflows/CI/badge.svg" alt="Test">
+  </a>
+  <a href="https://github.com/developmentseed/stac-fastapi-html-middleware/blob/main/LICENSE" target="_blank">
+      <img src="https://img.shields.io/github/license/developmentseed/stac-fastapi-html-middleware.svg" alt="License">
+  </a>
+</p>
+
+
+---
+
+**Documentation**:
+
+**Source Code**: <a href="https://github.com/developmentseed/stac-fastapi-html-middleware" target="_blank">https://github.com/developmentseed/stac-fastapi-html-middleware</a>
+
+---
+
+## Install
+
+```bash
+$ git clone https://github.com/developmentseed/stac-fastapi-html-middleware.git
+$ cd stac-fastapi-html-middleware
+$ python -m pip install -e .
+```
+
+## What
+
+The `HTMLRenderMiddleware` is designed to intercept responses from stac-fastapi application (`json` or `geojson`) and to encode it to HTML responses when:
+- the user set `f=html` query-parameter
+- `Accept: text/html` request's headers is the highest *priority*
+
+## How
+
+```python
+from starlette.middleware import Middleware
+
+from stac_fastapi.api.app import StacApi
+from stac_fastapi.html.middleware import HTMLRenderMiddleware
+
+api = StacApi(
+    middlewares=[
+        Middleware(HTMLRenderMiddleware),
+    ],
+)
+```
+
+## Contribution & Development
+
+See [CONTRIBUTING.md](https://github.com/developmentseed/stac-fastapi-html-middleware/blob/main/CONTRIBUTING.md)
+
+## License
+
+See [LICENSE](https://github.com/developmentseed/stac-fastapi-html-middleware/blob/main/LICENSE)
+
+## Authors
+
+Created by [Development Seed](<http://developmentseed.org>)
+
+## Changes
+
+See [CHANGES.md](https://github.com/developmentseed/stac-fastapi-html-middleware/blob/main/CHANGES.md).
+