Skip to content

Commit 021a4b4

Browse files
committed
doc update
1 parent 1f6b00c commit 021a4b4

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,14 +90,14 @@ docker run --name titiler \
9090
--rm -it developmentseed/titiler
9191
```
9292

93-
- AWS ECR: https://gallery.ecr.aws/s2n1v5w1/titiler
93+
- AWS ECR: https://gallery.ecr.aws/developmentseed/titiler
9494

9595
```bash
9696
docker run --name titiler \
9797
-p 8000:8000 \
9898
--env PORT=8000 \
9999
--env WORKERS_PER_CORE=1 \
100-
--rm -it public.ecr.aws/s2n1v5w1/titiler
100+
--rm -it public.ecr.aws/developmentseed/titiler
101101
```
102102

103103
Some options can be set via environment variables, see: https://github.com/tiangolo/uvicorn-gunicorn-docker#advanced-usage

docs/endpoints/stac.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Read Info/Metadata and create Web map Tiles from a **single** STAC Item.
44

55
```python
6-
# Minimal FastAPI app with COG support
6+
# Minimal FastAPI app with STAC support
77
from titiler.endpoints import stac
88

99
from fastapi import FastAPI
@@ -12,6 +12,16 @@ app = FastAPI()
1212

1313
# The STAC Tiler is created with the TilerFactory with the `stac` prefix
1414
app.include_router(stac.router, prefix="/stac", tags=["SpatioTemporal Asset Catalog"])
15+
16+
################################################################################
17+
# OR using the Factory
18+
from rio_tiler.io import STACReader
19+
from titiler.endpoints.MultiBaseTilerFactory
20+
21+
stac = MultiBaseTilerFactory(reader=STACReader, router_prefix="stac")
22+
23+
app = FastAPI()
24+
app.include_router(stac.router, prefix="/stac", tags=["SpatioTemporal Asset Catalog"])
1525
```
1626

1727
## API
@@ -29,7 +39,7 @@ app.include_router(stac.router, prefix="/stac", tags=["SpatioTemporal Asset Cata
2939
| `GET` | `/stac/point/{lon},{lat}` | JSON | return pixel value from a dataset
3040
| `GET` | `/stac/preview[.{format}]` | image/bin | create a preview image from a dataset
3141
| `GET` | `/stac/crop/{minx},{miny},{maxx},{maxy}[/{width}x{height}].{format}` | image/bin | create an image from part of a dataset
32-
| `GET` | `/stac/viewer` | HTML | demo webpage
42+
| `GET` | `/stac/viewer` | HTML | demo webpage (Not created by the factory)
3343

3444
## Description
3545

@@ -237,6 +247,8 @@ Example:
237247

238248
### Demo
239249

250+
Demonstration viewer added to the router created by the factory (https://github.com/developmentseed/titiler/blob/1f6b00cd50d60acae7b41ee108f80ad08fa52094/titiler/endpoints/stac.py#L14-L26).
251+
240252
`:endpoint:/stac/viewer` - STAC viewer
241253

242254
- QueryParams:

0 commit comments

Comments
 (0)