more docs

Author: vincentsarago

README.md

@@ -23,6 +23,8 @@
 
 ---
 
+`TiFeatures`, pronounced **tee-Features**, is a python package which helps creating lightweight **Features** server for PostGIS Database. The API has been designed with respect to [OGC Features API specification](https://github.com/opengeospatial/ogcapi-features).
+
 ## Install
 
 ```bash
@@ -62,6 +64,12 @@ Part 1: Core             | ✅ | https://docs.ogc.org/is/17-069r4/17-069r4.html
 Part 2: CRS by Reference | ❌ | https://docs.ogc.org/is/18-058r1/18-058r1.html
 Part 3: Filtering / CQL2 | ✅ | https://docs.ogc.org/DRAFTS/19-079r1.html
 
+Notes:
+
+The project authors choose not to implement the Part 2 of the specification to avoid the introduction of CRS based GeoJSON. This might change in the future.
+
+While the authors tried to follow the specification (part 1 and 3) to the letter, some API endpoints might have more capacities (e.g geometry column selection).
+
 ## Contribution & Development
 
 See [CONTRIBUTING.md](https://github.com/developmentseed/tifeatures/blob/master/CONTRIBUTING.md)

docs/mkdocs.yml

@@ -20,6 +20,8 @@ nav:
   - TiFeatures: "index.md"
   - Tutorial - User Guide:
     - "Endpoints": endpoints.md
+  - Advanced User Guide:
+    - "Combine MVT and Features": advanced/timvt_and_tifeatures.md
   - API:
     - db: api/tifeatures/db.md
     - dbmodel: api/tifeatures/dbmodel.md

docs/src/advanced/timvt_and_tifeatures.md

@@ -0,0 +1,52 @@
+
+
+`TiFeatures` and [`TiMVT`](https://github.com/developmentseed/timvt) share a lot of in common and it's possible to create a unique FastAPI application with both **Features** and **MVT** endpoints:
+
+```python
+"""Features and MVT app."""
+
+from tifeatures.db import close_db_connection, connect_to_db, register_table_catalog
+from tifeatures.factory import Endpoints
+from timvt.factory import VectorTilerFactory
+from fastapi import FastAPI
+from starlette_cramjam.middleware import CompressionMiddleware
+
+app = FastAPI(
+    title="Features and MVT",
+    openapi_url="/api",
+    docs_url="/api.html",
+)
+
+# Register endpoints.
+endpoints = Endpoints()
+app.include_router(endpoints.router, tags=["Features"])
+
+# By default the VectorTilerFactory will only create tiles/ and tilejson.json endpoints
+mvt_endpoints = VectorTilerFactory()
+app.include_router(mvt_endpoints.router)
+
+app.add_middleware(CompressionMiddleware)
+
+
+@app.on_event("startup")
+async def startup_event() -> None:
+    """Connect to database on startup."""
+    await connect_to_db(app)
+    # TiMVT and TiFeatures share the same `Table_catalog` format
+    # see https://github.com/developmentseed/timvt/pull/83
+    await register_table_catalog(app)
+
+
+@app.on_event("shutdown")
+async def shutdown_event() -> None:
+    """Close database connection."""
+    await close_db_connection(app)
+```
+
+!!! Note
+    To run the example, copy the code to a file main.py, and start uvicorn with:
+
+    `uvicorn main:app --reload`
+
+
+![](https://user-images.githubusercontent.com/10407788/175392407-d8cf4fec-497c-42a7-ae8f-d754962bf1e7.png)