fix(readme)
Browse files
README.md
CHANGED
|
@@ -98,7 +98,7 @@ chroma_db/ # Vector DB storage (ignored in Git)
|
|
| 98 |
- - - π http://127.0.0.1:8000
|
| 99 |
|
| 100 |
|
| 101 |
-
|
| 102 |
|
| 103 |
- - Signup β POST /signup with username & password
|
| 104 |
|
|
@@ -106,20 +106,20 @@ chroma_db/ # Vector DB storage (ignored in Git)
|
|
| 106 |
|
| 107 |
- - Use Authorization: Bearer <access_token> for protected endpoints
|
| 108 |
|
| 109 |
-
|
| 110 |
|
| 111 |
-
-
|
| 112 |
|
| 113 |
-
-
|
| 114 |
|
| 115 |
-
-
|
| 116 |
|
| 117 |
-
-
|
| 118 |
|
| 119 |
-
|
| 120 |
|
| 121 |
-
-
|
| 122 |
|
| 123 |
-
-
|
| 124 |
|
| 125 |
-
-
|
|
|
|
| 98 |
- - - π http://127.0.0.1:8000
|
| 99 |
|
| 100 |
|
| 101 |
+
## π Authentication Flow
|
| 102 |
|
| 103 |
- - Signup β POST /signup with username & password
|
| 104 |
|
|
|
|
| 106 |
|
| 107 |
- - Use Authorization: Bearer <access_token> for protected endpoints
|
| 108 |
|
| 109 |
+
## π Document Workflow
|
| 110 |
|
| 111 |
+
- User logs in
|
| 112 |
|
| 113 |
+
- Upload document β POST /upload (PDF or TXT)
|
| 114 |
|
| 115 |
+
- Ask a question β GET /ask?q=your+question
|
| 116 |
|
| 117 |
+
- The system searches your embeddings in ChromaDB and queries the LLM with context
|
| 118 |
|
| 119 |
+
## π Notes
|
| 120 |
|
| 121 |
+
- uploads/ and chroma_db/ are auto-created at runtime if they donβt exist.
|
| 122 |
|
| 123 |
+
- Both folders are ignored by Git (runtime data only).
|
| 124 |
|
| 125 |
+
- Contributions & pull requests are welcome π
|