From 64ebe71bc8effc2fc000f26f4dcf71b1af218e80 Mon Sep 17 00:00:00 2001 From: jonhealy1 Date: Wed, 10 Apr 2024 11:34:07 +0800 Subject: [PATCH] add logo to readme --- README.md | 17 ++++++++++++++++- docs/src/contributing.md | 0 docs/src/release-notes.md | 0 3 files changed, 16 insertions(+), 1 deletion(-) mode change 100644 => 120000 docs/src/contributing.md mode change 100644 => 120000 docs/src/release-notes.md diff --git a/README.md b/README.md index 0b7a49bb..d88ae058 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,23 @@ # stac-fastapi-elasticsearch-opensearch (sfeos) -## Elasticsearch and Opensearch backends for the stac-fastapi project + + +

+ +

Elasticsearch and Opensearch backends for the stac-fastapi project.

+ [![PyPI version](https://badge.fury.io/py/stac-fastapi.elasticsearch.svg)](https://badge.fury.io/py/stac-fastapi.elasticsearch) + +--- + +**Documentation**: [https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/) + +**Source Code**: [https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch) + +--- + +### Notes: - 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. - 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. diff --git a/docs/src/contributing.md b/docs/src/contributing.md deleted file mode 100644 index f939e75f..00000000 --- a/docs/src/contributing.md +++ /dev/null @@ -1 +0,0 @@ -../../CONTRIBUTING.md \ No newline at end of file diff --git a/docs/src/contributing.md b/docs/src/contributing.md new file mode 120000 index 00000000..f939e75f --- /dev/null +++ b/docs/src/contributing.md @@ -0,0 +1 @@ +../../CONTRIBUTING.md \ No newline at end of file diff --git a/docs/src/release-notes.md b/docs/src/release-notes.md deleted file mode 100644 index 699cc9e7..00000000 --- a/docs/src/release-notes.md +++ /dev/null @@ -1 +0,0 @@ -../../CHANGELOG.md \ No newline at end of file diff --git a/docs/src/release-notes.md b/docs/src/release-notes.md new file mode 120000 index 00000000..699cc9e7 --- /dev/null +++ b/docs/src/release-notes.md @@ -0,0 +1 @@ +../../CHANGELOG.md \ No newline at end of file