Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
capjamesg authored Oct 16, 2024
1 parent 89ff6d0 commit 9170c84
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,24 @@ To install this project, run:
pip install git+https://github.com/capjamesg/jamesql
```

## Quickstart

Here is a quickstart with a string-based query:

```
from jamesql import JameSQL
index = JameSQL.load()
index.add({"title": "tolerate it", "lyric": "Use my best colors for your portrait"})
# results should return in < 1ms, whether you have one or 1k documents
results = index.string_query_search("title:'tolerate it' colors")
print(results)
# {'documents': [{'title': 'tolerate it', 'lyric': 'Use my best colors for your portrait' ...}]
```

## Usage

### Create a database
Expand Down

0 comments on commit 9170c84

Please sign in to comment.