diff --git a/stac_fastapi/core/README.md b/stac_fastapi/core/README.md deleted file mode 120000 index fe840054..00000000 --- a/stac_fastapi/core/README.md +++ /dev/null @@ -1 +0,0 @@ -../../README.md \ No newline at end of file diff --git a/stac_fastapi/core/README.md b/stac_fastapi/core/README.md new file mode 100644 index 00000000..6f89cb4a --- /dev/null +++ b/stac_fastapi/core/README.md @@ -0,0 +1,20 @@ +# stac-fastapi-core + +Core functionality for stac-fastapi. For full documentation, please see the [main README](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/blob/main/README.md). + +## Package Information + +- **Package name**: stac-fastapi-core +- **Description**: Core functionality for STAC API implementations. +- **Documentation**: [https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/) +- **Source**: [GitHub Repository](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/) + +## Installation + +```bash +pip install stac-fastapi-core +``` + +## Quick Start + +For detailed usage and examples, please refer to the [main documentation](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/). diff --git a/stac_fastapi/elasticsearch/README.md b/stac_fastapi/elasticsearch/README.md deleted file mode 120000 index fe840054..00000000 --- a/stac_fastapi/elasticsearch/README.md +++ /dev/null @@ -1 +0,0 @@ -../../README.md \ No newline at end of file diff --git a/stac_fastapi/elasticsearch/README.md b/stac_fastapi/elasticsearch/README.md new file mode 100644 index 00000000..2ffe21b2 --- /dev/null +++ b/stac_fastapi/elasticsearch/README.md @@ -0,0 +1,20 @@ +# stac-fastapi-elasticsearch + +This is the Elasticsearch backend for stac-fastapi. For full documentation, please see the [main README](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/blob/main/README.md). + +## Package Information + +- **Package name**: stac-fastapi-elasticsearch +- **Description**: An implementation of STAC API based on the FastAPI framework with Elasticsearch. +- **Documentation**: [https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/) +- **Source**: [GitHub Repository](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/) + +## Installation + +```bash +pip install stac-fastapi-elasticsearch +``` + +## Quick Start + +For detailed usage and examples, please refer to the [main documentation](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/). diff --git a/stac_fastapi/opensearch/README.md b/stac_fastapi/opensearch/README.md deleted file mode 120000 index fe840054..00000000 --- a/stac_fastapi/opensearch/README.md +++ /dev/null @@ -1 +0,0 @@ -../../README.md \ No newline at end of file diff --git a/stac_fastapi/opensearch/README.md b/stac_fastapi/opensearch/README.md new file mode 100644 index 00000000..27b69841 --- /dev/null +++ b/stac_fastapi/opensearch/README.md @@ -0,0 +1,20 @@ +# stac-fastapi-opensearch + +This is the OpenSearch backend for stac-fastapi. For full documentation, please see the [main README](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/blob/main/README.md). + +## Package Information + +- **Package name**: stac-fastapi-opensearch +- **Description**: An implementation of STAC API based on the FastAPI framework with OpenSearch. +- **Documentation**: [https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/) +- **Source**: [GitHub Repository](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/) + +## Installation + +```bash +pip install stac-fastapi-opensearch +``` + +## Quick Start + +For detailed usage and examples, please refer to the [main documentation](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/). diff --git a/stac_fastapi/sfeos_helpers/README.md b/stac_fastapi/sfeos_helpers/README.md deleted file mode 120000 index fe840054..00000000 --- a/stac_fastapi/sfeos_helpers/README.md +++ /dev/null @@ -1 +0,0 @@ -../../README.md \ No newline at end of file diff --git a/stac_fastapi/sfeos_helpers/README.md b/stac_fastapi/sfeos_helpers/README.md new file mode 100644 index 00000000..108ba60b --- /dev/null +++ b/stac_fastapi/sfeos_helpers/README.md @@ -0,0 +1,22 @@ +# sfeos-helpers + +Helper utilities for the stac-fastapi project. For full documentation, please see the [main README](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/blob/main/README.md). + +## Package Information + +- **Package name**: sfeos-helpers +- **Description**: Helper utilities for the stac-fastapi project. +- **Documentation**: [https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/) +- **Source**: [GitHub Repository](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/) + +## Installation + +This package is a dependency of stac-fastapi-elasticsearch and stac-fastapi-opensearch and is typically installed automatically. + +```bash +pip install stac-fastapi-elasticsearch # or stac-fastapi-opensearch +``` + +## Quick Start + +For detailed usage and examples, please refer to the [main documentation](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/).