Restore demo GIFs and clean up README presentation
- Added back the two essential demo GIFs showing synthesis and exploration modes - Moved logo to be smaller and inline with title (40x40px) - Removed all demo creation scripts and development artifacts - Clean, professional presentation ready for GitHub release - Repository now contains only production-ready files
This commit is contained in:
parent
be488c5a3d
commit
1a5cc535a1
16
README.md
16
README.md
@ -1,15 +1,19 @@
|
|||||||
# FSS-Mini-RAG
|
# FSS-Mini-RAG <img src="assets/Fss_Mini_Rag.png" alt="FSS-Mini-RAG Logo" width="40" height="40">
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
> **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
|
||||||
|
|
||||||
```mermaid
|
```mermaid
|
||||||
graph LR
|
graph LR
|
||||||
Files[📁 Your Code] --> Index[🔍 Index]
|
Files[📁 Your Code/Documents] --> Index[🔍 Index]
|
||||||
Index --> Chunks[✂️ Smart Chunks]
|
Index --> Chunks[✂️ Smart Chunks]
|
||||||
Chunks --> Embeddings[🧠 Semantic Vectors]
|
Chunks --> Embeddings[🧠 Semantic Vectors]
|
||||||
Embeddings --> Database[(💾 Vector DB)]
|
Embeddings --> Database[(💾 Vector DB)]
|
||||||
@ -108,7 +112,9 @@ 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
|
||||||
```
|
```
|
||||||
|
|
||||||
*Ready to try semantic search with synthesis and exploration modes? Follow the quick start below!*
|

|
||||||
|
|
||||||
|
*Advanced usage: semantic search with synthesis and exploration modes*
|
||||||
|
|
||||||
## Installation Options
|
## Installation Options
|
||||||
|
|
||||||
|
|||||||
BIN
recordings/fss-mini-rag-demo-20250812_160725.gif
Normal file
BIN
recordings/fss-mini-rag-demo-20250812_160725.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 185 KiB |
BIN
recordings/fss-mini-rag-demo-20250812_161410.gif
Normal file
BIN
recordings/fss-mini-rag-demo-20250812_161410.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 179 KiB |
Loading…
x
Reference in New Issue
Block a user