Skip to content

Commit 1d7f2c5

Browse files
committed
adding ToC to readme
1 parent 75ea79c commit 1d7f2c5

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,35 @@
99

1010
> 📢 **Early Release**: This is an early release of async-cassandra. While it has been tested extensively, you may encounter edge cases. We welcome your feedback and contributions! Please report any issues on our [GitHub Issues](https://github.com/axonops/async-python-cassandra-client/issues) page.
1111
12+
## 📑 Table of Contents
13+
14+
- [✨ Overview](#-overview)
15+
- [🏗️ Why create this framework?](#️-why-create-this-framework)
16+
- [Understanding Async vs Sync](#understanding-async-vs-sync)
17+
- [The Benefits](#the-benefits)
18+
- [🔄 True Async Paging](#-true-async-paging)
19+
- [⚠️ Important Limitations](#️-important-limitations)
20+
- [🚀 Key Features](#-key-features)
21+
- [🔀 Alternative Libraries](#-alternative-libraries)
22+
- [📋 Requirements](#-requirements)
23+
- [🔌 CQL Protocol Version Requirement](#-cql-protocol-version-requirement)
24+
- [🔧 Installation](#-installation)
25+
- [📚 Quick Start](#-quick-start)
26+
- [🤝 Contributing](#-contributing)
27+
- [📞 Support](#-support)
28+
- [📖 Documentation](#-documentation)
29+
- [Getting Started](#getting-started)
30+
- [Advanced Topics](#advanced-topics)
31+
- [Examples](#examples)
32+
- [🎯 Running the Examples](#-running-the-examples)
33+
- [Available Examples](#available-examples)
34+
- [Running with External Cassandra](#running-with-external-cassandra)
35+
- [Example Descriptions](#example-descriptions)
36+
- [⚡ Performance](#-performance)
37+
- [📝 License](#-license)
38+
- [🙏 Acknowledgments](#-acknowledgments)
39+
- [⚖️ Legal Notices](#️-legal-notices)
40+
1241
## ✨ Overview
1342

1443
A Python library that enables the Cassandra driver to work seamlessly with async frameworks like FastAPI, aiohttp, and Quart. It provides an async/await interface that prevents blocking your application's event loop while maintaining full compatibility with the DataStax Python driver.

0 commit comments

Comments
 (0)