diff --git a/CHANGELOG.md b/CHANGELOG.md index 1ed87e11..698d8de5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ### Added +- Symlinks from project-specific readme files to main readme [#250](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/250) - Support for Python 3.12 [#234](https://github.com/stac-utils/stac-fastapi-elasticsearch/pull/234) ### Changed diff --git a/README.md b/README.md index 3723f2f9..77a60974 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@

Elasticsearch and Opensearch backends for the stac-fastapi project.

+

Featuring stac-fastapi.core for simplifying the creation and maintenance of custom STAC api backends.

diff --git a/stac_fastapi/core/README.md b/stac_fastapi/core/README.md deleted file mode 100644 index 02f4e35a..00000000 --- a/stac_fastapi/core/README.md +++ /dev/null @@ -1 +0,0 @@ -# stac-fastapi core library for Elasticsearch and Opensearch backends \ No newline at end of file diff --git a/stac_fastapi/core/README.md b/stac_fastapi/core/README.md new file mode 120000 index 00000000..fe840054 --- /dev/null +++ b/stac_fastapi/core/README.md @@ -0,0 +1 @@ +../../README.md \ No newline at end of file diff --git a/stac_fastapi/elasticsearch/README.md b/stac_fastapi/elasticsearch/README.md deleted file mode 100644 index 85e9dd1d..00000000 --- a/stac_fastapi/elasticsearch/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# stac-fastapi-elasticsearch - -## Requirements - -The Elasticsearch backend requires **elasticsearch**. diff --git a/stac_fastapi/elasticsearch/README.md b/stac_fastapi/elasticsearch/README.md new file mode 120000 index 00000000..fe840054 --- /dev/null +++ b/stac_fastapi/elasticsearch/README.md @@ -0,0 +1 @@ +../../README.md \ No newline at end of file diff --git a/stac_fastapi/opensearch/README.md b/stac_fastapi/opensearch/README.md deleted file mode 100644 index 2b1e991f..00000000 --- a/stac_fastapi/opensearch/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# stac-fastapi-opensearch - -## Requirements - -The Opensearch backend requires **opensearch**. \ No newline at end of file diff --git a/stac_fastapi/opensearch/README.md b/stac_fastapi/opensearch/README.md new file mode 120000 index 00000000..fe840054 --- /dev/null +++ b/stac_fastapi/opensearch/README.md @@ -0,0 +1 @@ +../../README.md \ No newline at end of file