Skip to content

Commit cd0cfb6

Browse files
committed
add contributions note to readme
1 parent 5b3c435 commit cd0cfb6

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,23 @@
1111

1212
---
1313

14-
**Documentation**: [https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/)
14+
**Online Documentation**: [https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/)
1515

1616
**Source Code**: [https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch)
1717

18+
1819
---
1920

2021
### Notes:
2122

2223
- Our Api core library can be used to create custom backends. See [stac-fastapi-mongo](https://github.com/Healy-Hyperspatial/stac-fastapi-mongo) for a working example.
2324
- Reach out on our [Gitter](https://app.gitter.im/#/room/#stac-fastapi-elasticsearch_community:gitter.im) channel or feel free to add to our [Discussions](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/discussions) page here on github.
2425
- There is [Postman](https://documenter.getpostman.com/view/12888943/2s8ZDSdRHA) documentation here for examples on how to run some of the API routes locally - after starting the elasticsearch backend via the docker-compose.yml file.
25-
- The `/examples` folder shows an example of running stac-fastapi-elasticsearch from PyPI in docker without needing any code from the repository. There is also a Postman collection here that you can load into Postman for testing the API routes.
26+
- The `/examples` folder shows an example of running stac-fastapi-elasticsearch from PyPI in docker without needing any code from the repository. There is also a Postman collection here that you can load into Postman for testing the API routes.
27+
28+
- For changes, see the [Changelog](CHANGELOG.md)
29+
- We are always welcoming contributions. For the development notes: [Contributing](CONTRIBUTING.md)
30+
2631

2732
### To install from PyPI:
2833

@@ -33,10 +38,6 @@ or
3338
```
3439
pip install stac_fastapi.opensearch
3540
```
36-
37-
#### For changes, see the [Changelog](CHANGELOG.md)
38-
39-
#### Development notes: [Contributing](CONTRIBUTING.md)
4041

4142
## Build Elasticsearh API backend
4243

0 commit comments

Comments
 (0)