From 68bd30a8100c22112c59ec668e4065e841842ab8 Mon Sep 17 00:00:00 2001 From: John Burbridge Date: Fri, 21 Mar 2025 11:29:40 -0700 Subject: [PATCH] docs: add Documentation section with links to docs resources --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b33e310..75e7d4b 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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. \ No newline at end of file +This project is licensed under the MIT License - see the LICENSE file for details. \ No newline at end of file