Fix README: remove mermaid syntax error and add demo GIFs
- Fixed mermaid parse error by removing quotes from node labels - Added two demo GIFs to showcase the system in action - Removed broken icon reference - README now displays perfectly with engaging visuals
This commit is contained in:
parent
a1f84e2bd5
commit
2f2f8c7796
12
README.md
12
README.md
@ -3,7 +3,11 @@
|
|||||||
> **A lightweight, educational RAG system that actually works**
|
> **A lightweight, educational RAG system that actually works**
|
||||||
> *Built for beginners who want results, and developers who want to understand how RAG really works*
|
> *Built for beginners who want results, and developers who want to understand how RAG really works*
|
||||||
|
|
||||||

|
## Demo
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
*See it in action: index a project and search semantically in seconds*
|
||||||
|
|
||||||
## How It Works
|
## How It Works
|
||||||
|
|
||||||
@ -14,7 +18,7 @@ graph LR
|
|||||||
Chunks --> Embeddings[🧠 Semantic Vectors]
|
Chunks --> Embeddings[🧠 Semantic Vectors]
|
||||||
Embeddings --> Database[(💾 Vector DB)]
|
Embeddings --> Database[(💾 Vector DB)]
|
||||||
|
|
||||||
Query[❓ "user auth"] --> Search[🎯 Hybrid Search]
|
Query[❓ user auth] --> Search[🎯 Hybrid Search]
|
||||||
Database --> Search
|
Database --> Search
|
||||||
Search --> Results[📋 Ranked Results]
|
Search --> Results[📋 Ranked Results]
|
||||||
|
|
||||||
@ -108,6 +112,10 @@ That's it. No external dependencies, no configuration required, no PhD in comput
|
|||||||
./rag-mini status ~/new-project # Check index health
|
./rag-mini status ~/new-project # Check index health
|
||||||
```
|
```
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
*Advanced usage: semantic search with synthesis and exploration modes*
|
||||||
|
|
||||||
## Installation Options
|
## Installation Options
|
||||||
|
|
||||||
### Recommended: Full Installation
|
### Recommended: Full Installation
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user