Skip to content

Commit 53c88e3

Browse files
committed
redesign readme
1 parent 4664737 commit 53c88e3

File tree

2 files changed

+369
-229
lines changed

2 files changed

+369
-229
lines changed

CHANGELOG.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,27 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
66
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
77

8+
89
## [Unreleased]
910

1011
### Added
1112

13+
- Created new `sfeos_helpers` package to improve code organization and maintainability [#376](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/376)
14+
1215
### Changed
1316

17+
- Refactored utility functions into dedicated modules within `sfeos_helpers` [#376](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/376):
18+
- Created `database` package with specialized modules for index, document, and utility operations
19+
- Created `aggregation` package for Elasticsearch/OpenSearch-specific aggregation functionality
20+
- Moved shared logic from core module to helper functions for better code reuse
21+
- Separated utility functions from constant mappings for clearer code organization
22+
- Improved README documentation with consistent formatting and enhanced sections [#376](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/376):
23+
- Added a comprehensive Quick Start guide
24+
- Reorganized sections for better navigation
25+
- Reformatted content with bullet points for improved readability
26+
- Added more detailed examples for API interaction
27+
- Updated documentation to reflect recent code refactoring
28+
1429
### Fixed
1530

1631

0 commit comments

Comments
 (0)