Skip to content

Commit c43a5f0

Browse files
authored
Readme redesign (#381)
**Related Issue(s):** - None **Description:** - Improved README documentation with consistent formatting and enhanced sections: - Added sfeos logo and banner - Added a comprehensive Quick Start guide - Reorganized sections for better navigation - Reformatted content with bullet points for improved readability - Added more detailed examples for API interaction **PR Checklist:** - [x] Code is formatted and linted (run `pre-commit run --all-files`) - [x] Tests pass (run `make test`) - [x] Documentation has been updated to reflect changes, if applicable - [x] Changes are added to the changelog
1 parent b0450eb commit c43a5f0

File tree

9 files changed

+414
-260
lines changed

9 files changed

+414
-260
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
1111

1212
### Changed
1313

14+
- Improved README documentation with consistent formatting and enhanced sections [#381](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/381):
15+
- Added sfeos logo and banner
16+
- Added a comprehensive Quick Start guide
17+
- Reorganized sections for better navigation
18+
- Reformatted content with bullet points for improved readability
19+
- Added more detailed examples for API interaction
20+
1421
### Fixed
1522

1623

README.md

Lines changed: 396 additions & 260 deletions
Large diffs are not rendered by default.

assets/STAC-01.png

55 KB
Loading

assets/elasticsearch.png

81.9 KB
Loading

assets/fastapi.svg

Lines changed: 1 addition & 0 deletions
Loading

assets/opensearch.svg

Lines changed: 10 additions & 0 deletions
Loading

assets/python.png

19.7 KB
Loading

assets/sfeos.png

1.67 MB
Loading

assets/stac-030-long.png

-95.9 KB
Binary file not shown.

0 commit comments

Comments
 (0)