Skip to content

Commit b087356

Browse files
author
Daniele Briggi
committed
chore(readme): small improvement
1 parent d55ee42 commit b087356

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ A hybrid search engine built on SQLite with [SQLite AI](https://github.com/sqlit
2121
## Installation
2222

2323
```bash
24+
python -m venv .venv
25+
source .venv/bin/activate # On Windows: .venv\Scripts\activate
2426
pip install sqlite-rag
2527
```
2628

@@ -32,14 +34,16 @@ Download the model [Embedding Gemma](https://huggingface.co/unsloth/embeddinggem
3234
sqlite-rag download-model unsloth/embeddinggemma-300m-GGUF embeddinggemma-300M-Q8_0.gguf
3335
```
3436

35-
Then start with default settings:
37+
SQLite RAG comes preconfigured to work with the **Embedding Gemma** model. When you add a document or text, it automatically creates a new database (if one does not already exist) and uses default settings, so you can get started immediately without manual setup.
3638

3739
```bash
3840
# Initialize sqliterag.sqlite database and add documents
41+
sqlite-rag add-text "Artificial intelligence (AI) enables machines to learn from data"
42+
3943
sqlite-rag add /path/to/documents --recursive
4044

4145
# Search your documents
42-
sqlite-rag search "your search query"
46+
sqlite-rag search "explain AI"
4347

4448
# Interactive mode
4549
sqlite-rag
@@ -61,24 +65,23 @@ sqlite-rag --help
6165
Settings are stored in the database and should be set before adding any documents.
6266

6367
```bash
64-
# Interactive configuration
65-
sqlite-rag configure
68+
# View available configuration options
69+
sqlite-rag configure --help
70+
71+
sqlite-rag configure --model-path ./mymodels/path
6672

6773
# View current settings
6874
sqlite-rag settings
69-
70-
# View available configuration options
71-
sqlite-rag configure --help
7275
```
7376

74-
To use a different database path, use the global `--database` option:
77+
To use a different database filename, use the global `--database` option:
7578

7679
```bash
7780
# Single command with custom database
78-
sqlite-rag --database mydb.db add-text "What's AI?"
81+
sqlite-rag --database path/to/mydb.db add-text "Let's talk about AI."
7982

8083
# Interactive mode with custom database
81-
sqlite-rag --database mydb.db
84+
sqlite-rag --database path/to/mydb.db
8285
```
8386

8487
### Model Management

0 commit comments

Comments
 (0)