Skip to content

Commit e8d2b63

Browse files
committed
update readme
1 parent 339c94e commit e8d2b63

File tree

2 files changed

+9
-12
lines changed

2 files changed

+9
-12
lines changed

README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1-
# Ragadoc 🤖📄
2-
3-
**An AI document assistant that answers questions about your PDFs with citations and highlights them directly in the document.**
4-
5-
Ragadoc is a privacy-first Streamlit application that lets you chat with your documents using locally-run AI models. Ask questions, get grounded answers with citations, and see exactly where the information comes from with automatic PDF highlighting.
1+
<div align="center">
2+
<img src="assets/logo.png" alt="Ragadoc Logo" width="120" height="120">
3+
4+
# ragadoc
5+
6+
**An AI document assistant that answers questions about your PDFs with citations and highlights them directly in the document.**
7+
8+
<p><em>Ragadoc is a privacy-first Streamlit application that lets you chat with your documents using locally-run AI models. Ask questions, get grounded answers with citations, and see exactly where the information comes from with automatic PDF highlighting.</em></p>
9+
</div>
610

711
## ✨ Key Features
812

@@ -199,13 +203,6 @@ pytest
199203
flake8 ragadoc/
200204
```
201205

202-
## 📋 Requirements
203-
204-
- Python 3.8+
205-
- Ollama (for local AI models)
206-
- 4GB+ RAM (depending on chosen model)
207-
- PDF documents to analyze
208-
209206
## 🐛 Troubleshooting
210207

211208
### Common Issues

assets/logo.png

587 KB
Loading

0 commit comments

Comments
 (0)