Skip to content

Commit f7f7b00

Browse files
cleanup readme typos (#72)
1 parent 8f7e897 commit f7f7b00

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ R2R (RAG to Riches) is a Python framework designed for the rapid construction an
55

66
### Quick Install:
77

8-
1. **Install R2R directly using `pip`:**
8+
**Install R2R directly using `pip`:**
99

1010
```bash
1111
pip install r2r
@@ -27,7 +27,8 @@ Follow these steps to ensure a smooth setup:
2727
```
2828
- Install the project dependencies with Poetry:
2929
```bash
30-
# See pyproject for available extras, use "all" for every optional dep.
30+
# See pyproject.toml for available extras
31+
# use "all" to include every optional dependency
3132
poetry install --extras "parsing"
3233
```
3334

@@ -50,14 +51,14 @@ The project includes several basic examples that demonstrate application deploym
5051
poetry run uvicorn examples.basic.app:app
5152
```
5253

53-
2. [`run_client.py`](examples/basic/run_client.py): This example should be run after starting the main application. It demonstrates a test of the user client. This includes uploading text entries as well as a PDF.
54+
2. [`run_client.py`](examples/basic/run_client.py): This example should be run after starting the main application. It demonstrates uploading text entries as well as a PDF with the python client. Further, it shows document and user-level management with built-in features.
5455

5556
```bash
5657
poetry run python -m examples.client.test_client
5758
```
5859

5960

60-
2. [`run_pdf_chat.py`](examples/pdf_chat/run_demo.py): A more comprehensive example demonstrating more realistic pdf chat.
61+
3. [`run_pdf_chat.py`](examples/pdf_chat/run_demo.py): A more comprehensive example demonstrating upload and chat with a more realistic pdf.
6162
```bash
6263
# Ingest pdf
6364
poetry run python -m examples.pdf_chat.run_demo ingest
@@ -66,6 +67,13 @@ The project includes several basic examples that demonstrate application deploym
6667
poetry run python -m examples.pdf_chat.run_demo search "What are the key themes of Meditations?"
6768
```
6869

70+
4. [`web`](web/package.json): A web application which is meant to accompany the framework to provide visual intelligence.
71+
```bash
72+
cd web && pnpm install
73+
# Serve the web app
74+
pnpm dev
75+
```
76+
6977

7078
## Demonstration
7179

0 commit comments

Comments
 (0)