Skip to content

Commit 32704f0

Browse files
committed
update readme
1 parent cb14919 commit 32704f0

1 file changed

Lines changed: 18 additions & 35 deletions

File tree

README.md

Lines changed: 18 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@
66

77
# ConDB: The KV-Cache Native Context Database
88

9-
<p align="center">
10-
A new type of database optimized for reasoning-driven tree search — fast, context-aware retrieval at scale with up to 70% less token cost.
11-
</p>
9+
<p align="center"><i>A new context database for reasoning-driven retrieval via tree search.<br/>
10+
Fast, context-aware retrieval at scale with up to 70% less token cost.</i></p>
1211

1312
</div>
1413

@@ -47,7 +46,7 @@ Evolving, runtime context — agent memory, long conversations (via [ChatIndex](
4746

4847
---
4948

50-
## ⚡ Quick Start
49+
## 🚀 Getting Started
5150

5251
### Install
5352

@@ -92,9 +91,7 @@ tree_id = ct.index_markdown_file("doc.md", tree_builder=build_markdown_tree)
9291
ct.close()
9392
```
9493

95-
---
96-
97-
## ⚙️ Configuration
94+
### Configuration
9895

9996
Create a `.env` file:
10097

@@ -120,8 +117,8 @@ ConDB automatically selects the best retrieval strategy based on tree size:
120117

121118
| Strategy | Best for | How it works |
122119
|----------|----------|--------------|
123-
| **Beam** | Small trees (< 50 nodes) | LLM evaluates and selects promising branches at each depth level |
124-
| **Block** | Large documents (50+ nodes) | Splits tree into token-bounded blocks, LLM reasons over each block. KV-cache native — caches intermediate block results to cut token usage by up to 70% |
120+
| **Beam** | Small trees <br/> (< 50 nodes) | LLM evaluates and selects promising branches at each depth level |
121+
| **Block** | Large documents <br/> (50+ nodes) | Splits tree into token-bounded blocks, LLM reasons over each block. KV-cache native — caches intermediate block results to cut token usage by up to 70% |
125122

126123
You can also specify a strategy explicitly:
127124

@@ -151,7 +148,9 @@ These numbers are benchmark snapshots, not hard guarantees; exact cost and laten
151148

152149
---
153150

154-
## 🧩 Architecture
151+
## 🧩 Learn More
152+
153+
### Architecture
155154

156155
```
157156
contextdb/
@@ -170,12 +169,9 @@ contextdb/
170169
└── prompts/ # Jinja2 prompt templates
171170
```
172171

173-
---
174-
175-
## 🔌 Extending
172+
### Extending
176173

177-
<details>
178-
<summary><b>Custom Storage Backend</b></summary>
174+
**Custom Storage Backend**
179175

180176
```python
181177
from contextdb import StorageProtocol
@@ -187,10 +183,8 @@ class MyStorage:
187183

188184
ct = ContextTree(storage=MyStorage())
189185
```
190-
</details>
191186

192-
<details>
193-
<summary><b>Custom LLM Provider</b></summary>
187+
**Custom LLM Provider**
194188

195189
```python
196190
from contextdb import LLMProtocol
@@ -201,43 +195,32 @@ class MyLLM:
201195

202196
ct = ContextTree("db.sqlite", llm=MyLLM())
203197
```
204-
</details>
205198

206-
---
207-
208-
## 🧪 Testing
199+
### Testing
209200

210201
```bash
211202
./run_tests.sh all
212203
```
213204

214205
---
215206

216-
## 🧭 Related Projects
207+
## 💬 Community
208+
209+
### Related Projects
217210

218211
- [**PageIndex**](https://github.com/VectifyAI/PageIndex) — vectorless, reasoning-based RAG that builds hierarchical tree indexes from long documents
219212
- [**ChatIndex**](https://github.com/VectifyAI/ChatIndex) — tree indexing for long conversations, enabling reasoning-based retrieval over chat histories
220213
- [**AgentFS**](https://github.com/anthropics/agentfs) — filesystem for AI agents
221214

222-
---
223-
224-
## 📄 License
225-
226-
Apache-2.0
227-
228-
---
229-
230215
### Connect with Us
231216

232-
<div align="center">
233-
234217
[![Twitter](https://img.shields.io/badge/Twitter-000000?style=for-the-badge&logo=x&logoColor=white)](https://x.com/PageIndexAI)&ensp;
235218
[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/company/vectify-ai/)&ensp;
236219
[![Discord](https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.com/invite/VuXuf29EUj)&ensp;
237220
[![Contact Us](https://img.shields.io/badge/Contact_Us-3B82F6?style=for-the-badge&logo=envelope&logoColor=white)](https://ii2abc2jejf.typeform.com/to/tK3AXl8T)
238221

239-
</div>
240-
241222
---
242223

224+
Licensed under [Apache 2.0](LICENSE).
225+
243226
© 2026 [Vectify AI](https://vectify.ai)

0 commit comments

Comments
 (0)