Skip to content

Commit ef05b93

Browse files
committed
update readme
1 parent 9f54c9b commit ef05b93

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,17 @@
22

33
## Elasticsearch and Opensearch backends for the stac-fastapi project
44

5+
[![PyPI version](https://badge.fury.io/py/stac-fastapi.elasticsearch.svg)](https://badge.fury.io/py/stac-fastapi.elasticsearch)
56

7+
To install from PyPI:
8+
9+
```shell
10+
pip install stac_fastapi.elasticsearch
11+
```
12+
or
13+
```
14+
pip install stac_fastapi.opensearch
15+
```
616

717
#### For changes, see the [Changelog](CHANGELOG.md)
818

@@ -32,17 +42,17 @@ Prior to commit, run:
3242
pre-commit run --all-files
3343
```
3444

35-
36-
## Building
45+
## Build Elasticsearh API backend
3746

3847
```shell
39-
docker-compose build
48+
docker-compose up elasticsearch
49+
docker-compose build app-elasticsearch
4050
```
4151

42-
## Running API on localhost:8080
52+
## Running Elasticsearh API on localhost:8080
4353

4454
```shell
45-
docker-compose up
55+
docker-compose up app-elasticsearch
4656
```
4757

4858
By default, docker-compose uses Elasticsearch 8.x and OpenSearch 2.11.1.

0 commit comments

Comments
 (0)