Skip to content

Commit 36c2652

Browse files
committed
docs: update README
1 parent 2d3f5c4 commit 36c2652

2 files changed

Lines changed: 20 additions & 1 deletion

File tree

.vscode/extensions.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"recommendations": [
3+
"JipitiAI.askcodebase"
4+
]
5+
}

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,16 @@
11
# CodeIndex
2-
High Performance Codebase Index Engine for AI.
2+
3+
CodeIndex is a local-first high performance codebase index engine designed for AI. It helps your LLM understanding the structure and semantics of a codebase.
4+
5+
## Features
6+
7+
- **🔐 Privacy first:** All data is stored locally on your machine.
8+
- **🚀 High performance:** Indexing a middle codebase takes less than 1 second.
9+
- **🤖 AI ready:** The index is designed for AI, which means it's easy to provide codebase context to your LLM.
10+
- **⚙️ Configurable:** The index is designed to be configurable. You can customize the engine to fit your needs.
11+
12+
## Acknowledgement
13+
14+
1. [Sweep AI](https://github.com/sweepai/sweep) Sweep: AI-powered Junior Developer for small features and bug fixes.
15+
2. [SourceGraph](https://github.com/sourcegraph/sourcegraph) Code AI platform with Code Search & Cody
16+
3. [LLamaIndex](https://github.com/jerryjliu/llama_index) LlamaIndex (GPT Index) is a data framework for your LLM applications

0 commit comments

Comments
 (0)