Skip to content

Commit b1f76af

Browse files
committed
update readme
1 parent 115db6e commit b1f76af

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
# STAC FastAPI Elasticsearch
22

3-
Elasticsearch backend for stac-fastapi.
3+
## Elasticsearch backend for stac-fastapi
4+
-----
45

5-
Join our [Gitter](https://gitter.im/stac-fastapi-elasticsearch/community) page
6+
### Join our [Gitter](https://gitter.im/stac-fastapi-elasticsearch/community) page
67

7-
For changes, see the [Changelog](CHANGELOG.md).
8+
### Check out the public Postman documentation [Postman](https://documenter.getpostman.com/view/12888943/2s8ZDSdRHA)
9+
10+
### For changes, see the [Changelog](CHANGELOG.md)
11+
-----
812

913
## Development Environment Setup
1014

@@ -23,14 +27,14 @@ Prior to commit, run:
2327
```shell
2428
pre-commit run --all-files
2529
```
26-
30+
-----
2731

2832
## Building
2933

3034
```shell
3135
docker-compose build
3236
```
33-
37+
-----
3438
## Running API on localhost:8080
3539

3640
```shell
@@ -55,24 +59,26 @@ curl -X "POST" "http://localhost:8080/collections" \
5559
}'
5660
```
5761

58-
Note: this "Collections Transaction" behavior is not part of the STAC API, but may be soon.
59-
62+
Note: this "Collections Transaction" behavior is not part of the STAC API, but may be soon.
63+
64+
------
6065
## Testing
6166

6267
```shell
6368
make test
6469
```
65-
70+
-----
6671
## Ingest sample data
6772

6873
```shell
6974
make ingest
7075
```
71-
76+
-----
7277
## Elasticsearch Mappings
7378

74-
Mappings apply to search index, not source.
75-
79+
Mappings apply to search index, not source.
80+
81+
-----
7682
## Managing Elasticsearch Indices
7783

7884
This section covers how to create a snapshot repository and then create and restore snapshots with this.

0 commit comments

Comments
 (0)