Skip to content

Add Documentation Links Section #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
johnburbridge merged 1 commit into from
Mar 21, 2025
Merged

Add Documentation Links Section #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,16 @@ A Python package providing two implementations of a time-based storage system fo
- Timestamp collision handling
- Generic typing (store any data type)

## Documentation

Comprehensive documentation is available to help you get the most out of this library:

- [**Architecture Guide**](time_based_storage/docs/architecture.md) - Design principles, implementation details, and performance considerations
- [**Code Examples**](time_based_storage/docs/examples.py) - Practical usage examples and patterns
- [**Concurrent Use Cases**](time_based_storage/docs/concurrent_use_cases.md) - Real-world scenarios for concurrent access

The rest of this README provides an overview of installation, basic usage, and API reference.

## Installation

```bash
Expand Down Expand Up @@ -154,7 +164,11 @@ This library is well-suited for:
- Message queues with time-based priorities
- Session tracking

For more detailed use cases for concurrent access scenarios, see [Concurrent Use Cases](time_based_storage/docs/concurrent_use_cases.md).
For more detailed information about using this library in various scenarios, see:

- [**Architecture Guide**](time_based_storage/docs/architecture.md) - Learn about the design principles and implementation details
- [**Code Examples**](time_based_storage/docs/examples.py) - See practical examples of how to use the library
- [**Concurrent Use Cases**](time_based_storage/docs/concurrent_use_cases.md) - Explore real-world concurrent access scenarios

## Testing

Expand Down Expand Up @@ -199,4 +213,4 @@ flake8 time_based_storage/src time_based_storage/tests

## License

This project is licensed under the MIT License - see the LICENSE file for details.
This project is licensed under the MIT License - see the LICENSE file for details.