Merge pull request #34 from Healy-Hyperspatial/update-readme

Update readme, add table of contents, clean up/ re-format, add logo

Author: jonhealy1

CHANGELOG.md

@@ -12,11 +12,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0/
 - Add support for python 3.12. [#22](https://github.com/Healy-Hyperspatial/stac-fastapi-mongo/pull/22)
 - Updated sfeos core to v3.0.0a0, fixed datetime functionality. [#23](https://github.com/Healy-Hyperspatial/stac-fastapi-mongo/pull/23)
 - Create indexes in MongoDB at startup only if environment variable MONGO_CREATE_INDEXES is set to "true" (default when the env variable is not set: "true"). [#31](https://github.com/Healy-Hyperspatial/stac-fastapi-mongo/pull/31)
+- Improved README with table of contents, better formatting, and added Contributing section. [#34](https://github.com/Healy-Hyperspatial/stac-fastapi-mongo/pull/34)
 
 ### Fixed
 
 - Added a new index based on collection id and item id to ensure item IDs aren't required to be unique across all collections. [#26](https://github.com/Healy-Hyperspatial/stac-fastapi-mongo/pull/26)
-- Updated test fixtures to use ASGITransport with AsyncClient for compatibility with newer httpx versions.
+- Updated test fixtures to use ASGITransport with AsyncClient for compatibility with newer httpx versions. [#35](https://github.com/Healy-Hyperspatial/stac-fastapi-mongo/pull/35)
 
 ## [v3.2.1]
 

README.md

@@ -1,34 +1,62 @@
 # stac-fastapi-mongo
 
-## Mongo backend for the stac-fastapi project built on top of the [sfeos](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch) core api library.
+<!-- markdownlint-disable MD033 MD041 -->
+
+<p align="left">
+  <img src="assets/stac-fastapi-mongo.png" width=560>
+</p>
+
+
+MongoDB backend for the [stac-fastapi](https://github.com/stac-utils/stac-fastapi) project built on top of the [sfeos](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch) core API library.
 
 [![Downloads](https://static.pepy.tech/badge/stac-fastapi-mongo?color=blue)](https://pepy.tech/project/stac-fastapi-mongo)
-  [![GitHub contributors](https://img.shields.io/github/contributors/Healy-Hyperspatial/stac-fastapi-mongo?color=blue)](https://github.com/Healy-Hyperspatial/stac-fastapi-mongo/graphs/contributors)
-  [![GitHub stars](https://img.shields.io/github/stars/Healy-Hyperspatial/stac-fastapi-mongo.svg?color=blue)](https://github.com/Healy-Hyperspatial/stac-fastapi-mongo/stargazers)
-  [![GitHub forks](https://img.shields.io/github/forks/Healy-Hyperspatial/stac-fastapi-mongo.svg?color=blue)](https://github.com/Healy-Hyperspatial/stac-fastapi-mongo/network/members)
-   [![PyPI version](https://img.shields.io/pypi/v/stac-fastapi-mongo.svg?color=blue)](https://pypi.org/project/stac-fastapi-mongo/)
-  [![STAC](https://img.shields.io/badge/STAC-1.1.0-blue.svg)](https://github.com/radiantearth/stac-spec/tree/v1.1.0)
+[![GitHub contributors](https://img.shields.io/github/contributors/Healy-Hyperspatial/stac-fastapi-mongo?color=blue)](https://github.com/Healy-Hyperspatial/stac-fastapi-mongo/graphs/contributors)
+[![GitHub stars](https://img.shields.io/github/stars/Healy-Hyperspatial/stac-fastapi-mongo.svg?color=blue)](https://github.com/Healy-Hyperspatial/stac-fastapi-mongo/stargazers)
+[![GitHub forks](https://img.shields.io/github/forks/Healy-Hyperspatial/stac-fastapi-mongo.svg?color=blue)](https://github.com/Healy-Hyperspatial/stac-fastapi-mongo/network/members)
+[![PyPI version](https://img.shields.io/pypi/v/stac-fastapi-mongo.svg?color=blue)](https://pypi.org/project/stac-fastapi-mongo/)
+[![STAC](https://img.shields.io/badge/STAC-1.1.0-blue.svg)](https://github.com/radiantearth/stac-spec/tree/v1.1.0)
 
 <!-- [![Join the chat at https://gitter.im/stac-fastapi-mongo/community](https://badges.gitter.im/stac-fastapi-mongo/community.svg)](https://gitter.im/stac-fastapi-mongo/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -->
 
+## Table of Contents
+
+- [Installation](#installation)
+- [Development](#development)
+  - [Development Environment Setup](#development-environment-setup)
+  - [Pre-commit](#pre-commit)
+- [Running the API](#running-the-api)
+  - [Build and Run](#build-and-run)
+  - [Creating Collections](#creating-collections)
+  - [Collection Pagination](#collection-pagination)
+- [Testing](#testing)
+- [Sample Data](#sample-data)
+- [Authentication](#authentication)
+  - [Environment Variable Configuration](#environment-variable-configuration)
+  - [User Permissions Configuration](#user-permissions-configuration)
+  - [Public Endpoints Configuration](#public-endpoints-configuration)
+  - [Authentication Configurations](#authentication-configurations)
+- [Read-Only Databases](#note-for-read-only-databases)
+- [Contributing](#contributing)
+- [Changelog](#changelog)
+
+## Installation
+
 To install from PyPI:
 
 ```shell
 pip install stac_fastapi.mongo
 ```
 
-#### For changes, see the [Changelog](CHANGELOG.md)
-
+## Development
 
-## Development Environment Setup
+### Development Environment Setup
 
 To install the classes in your local Python env, run:
 
 ```shell
 pip install -e .[dev]
 ```
 
-
 ### Pre-commit
 
 Install [pre-commit](https://pre-commit.com/#install).
@@ -39,19 +67,25 @@ Prior to commit, run:
 pre-commit run --all-files
 ```
 
-## Build stac-fastapi.mongo backend
+## Running the API
+
+### Build and Run
+
+Build the MongoDB backend:
 
 ```shell
 docker-compose up mongo
 docker-compose build app-mongo
 ```
 
-## Running Mongo API on localhost:8084
+Run the MongoDB API on localhost:8084:
 
 ```shell
 docker-compose up app-mongo
 ```
 
+### Creating Collections
+
 To create a new Collection:
 
 ```shell
@@ -64,8 +98,7 @@ curl -X "POST" "http://localhost:8084/collections" \
 
 Note: this "Collections Transaction" behavior is not part of the STAC API, but may be soon.
 
-
-## Collection pagination
+### Collection Pagination
 
 The collections route handles optional `limit` and `token` parameters. The `links` field that is
 returned from the `/collections` route contains a `next` link with the token that can be used to
@@ -77,20 +110,23 @@ curl -X "GET" "http://localhost:8084/collections?limit=1&token=example_token"
 
 ## Testing
 
+Run the test suite:
+
 ```shell
 make test
 ```
 
+## Sample Data
 
-## Ingest sample data
+Ingest sample data:
 
 ```shell
 make ingest
 ```
 
-## Basic Auth
+## Authentication
 
-#### Environment Variable Configuration
+### Environment Variable Configuration
 
 Basic authentication is an optional feature. You can enable it by setting the environment variable `BASIC_AUTH` as a JSON string.
 
@@ -132,7 +168,6 @@ Example: This example illustrates the configuration for two users: an **admin**
 }
 ```
 
-
 ### Public Endpoints Configuration
 
 In order to set endpoints with public access, you can configure the public_endpoints key with a list of endpoint objects. Each endpoint object should specify the path and method of the endpoint.
@@ -163,10 +198,37 @@ Example: This example demonstrates the configuration for public endpoints, allow
 }
 ```
 
-### Basic Authentication Configurations
+### Authentication Configurations
 
 See `docker-compose.basic_auth_protected.yml` and `docker-compose.basic_auth_public.yml` for basic authentication configurations.
 
-## Note for read-only databases
+## Note for Read-Only Databases
+
+If you are using a read-only MongoDB user, the `MONGO_CREATE_INDEXES` environment variable should be set to "false" (as a string and not a boolean) to avoid creating indexes in the database. When this environment variable is not set, the default is to create indexes. See [GitHub issue #28](https://github.com/Healy-Hyperspatial/stac-fastapi-mongo/issues/28)
+
+## Contributing
+
+Contributions are welcome! Here's how you can help:
+
+### How to Contribute
+
+1. **Fork the repository** - Create your own fork of the project
+2. **Create a feature branch** - `git checkout -b feature/your-feature-name`
+3. **Commit your changes** - Make sure to write clear, concise commit messages
+4. **Push to your branch** - `git push origin feature/your-feature-name`
+5. **Open a Pull Request** - Describe your changes in detail
+
+### Development Guidelines
+
+- Follow the existing code style and conventions
+- Add tests for new features
+- Update documentation as needed
+- Make sure all tests pass before submitting a PR
+
+### Reporting Issues
+
+If you find a bug or have a feature request, please open an issue on the [GitHub repository](https://github.com/Healy-Hyperspatial/stac-fastapi-mongo/issues).
+
+## Changelog
 
-If you are using a read-only MongoDB user, the `MONGO_CREATE_INDEXES` environment variable should be set to "false" (as a string and not a boolean) to avoid creating indexes in the database. When this environment variable is not set, the default is to create indexes. See [Github issue #28](https://github.com/Healy-Hyperspatial/stac-fastapi-mongo/issues/28)
+For changes, see the [Changelog](CHANGELOG.md)