diff --git a/README.md b/README.md index 129317f..ee5fc30 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,19 @@ -# FSS-Mini-RAG - -![FSS-Mini-RAG Logo](assets/Fss_Mini_Rag.png) +# FSS-Mini-RAG FSS-Mini-RAG Logo > **A lightweight, educational RAG system that actually works** > *Built for beginners who want results, and developers who want to understand how RAG really works* +## Demo + +![FSS-Mini-RAG Demo](recordings/fss-mini-rag-demo-20250812_161410.gif) + +*See it in action: index a project and search semantically in seconds* + ## How It Works ```mermaid graph LR - Files[📁 Your Code] --> Index[🔍 Index] + Files[📁 Your Code/Documents] --> Index[🔍 Index] Index --> Chunks[✂️ Smart Chunks] Chunks --> Embeddings[🧠 Semantic Vectors] 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 ``` -*Ready to try semantic search with synthesis and exploration modes? Follow the quick start below!* +![FSS-Mini-RAG Search Demo](recordings/fss-mini-rag-demo-20250812_160725.gif) + +*Advanced usage: semantic search with synthesis and exploration modes* ## Installation Options diff --git a/recordings/fss-mini-rag-demo-20250812_160725.gif b/recordings/fss-mini-rag-demo-20250812_160725.gif new file mode 100644 index 0000000..50b5e12 Binary files /dev/null and b/recordings/fss-mini-rag-demo-20250812_160725.gif differ diff --git a/recordings/fss-mini-rag-demo-20250812_161410.gif b/recordings/fss-mini-rag-demo-20250812_161410.gif new file mode 100644 index 0000000..d8b0656 Binary files /dev/null and b/recordings/fss-mini-rag-demo-20250812_161410.gif differ