Skip to content

Commit 85b6acd

Browse files
committed
update readme
1 parent 957e03c commit 85b6acd

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
</p>
1010

1111

12-
[![PyPI version](https://badge.fury.io/py/stac-fastapi.elasticsearch.svg)](https://badge.fury.io/py/stac-fastapi.elasticsearch)
12+
[![PyPI version](https://badge.fury.io/py/stac-fastapi-elasticsearch.svg)](https://badge.fury.io/py/stac-fastapi-elasticsearch) [![PyPI version](https://badge.fury.io/py/stac-fastapi-opensearch.svg)](https://badge.fury.io/py/stac-fastapi-opensearch)
1313
[![Join the chat at https://gitter.im/stac-fastapi-elasticsearch/community](https://badges.gitter.im/stac-fastapi-elasticsearch/community.svg)](https://gitter.im/stac-fastapi-elasticsearch/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
1414

1515

@@ -35,14 +35,20 @@
3535

3636
### To install from PyPI:
3737

38-
```shell
39-
pip install stac_fastapi.elasticsearch
40-
```
41-
or
42-
```
43-
pip install stac_fastapi.opensearch
38+
```bash
39+
# For versions 4.0.0a1 and newer (PEP 625 compliant naming):
40+
pip install stac_fastapi_elasticsearch # Elasticsearch backend
41+
pip install stac_fastapi_opensearch # Opensearch backend
42+
pip install stac_fastapi_core # Core library
43+
44+
# For versions 4.0.0a0 and older:
45+
pip install stac-fastapi.elasticsearch # Elasticsearch backend
46+
pip install stac-fastapi.opensearch # Opensearch backend
47+
pip install stac-fastapi.core # Core library
4448
```
4549

50+
> **Important Note:** Starting with version 4.0.0a1, package names have changed from using periods (e.g., `stac-fastapi.core`) to using underscores (e.g., `stac_fastapi_core`) to comply with PEP 625. Please update your requirements files accordingly.
51+
4652
### To install and run via pre-built Docker Images
4753

4854
We provide ready-to-use Docker images through GitHub Container Registry ([ElasticSearch](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pkgs/container/stac-fastapi-es) and [OpenSearch](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pkgs/container/stac-fastapi-os) backends). You can easily pull and run these images:

0 commit comments

Comments
 (0)