Skip to content

Commit

Permalink
Update README.md with note on dev branch
Browse files Browse the repository at this point in the history
  • Loading branch information
icyveins7 authored Mar 17, 2024
1 parent 23c8889 commit 11b5d7b
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ There are no additional requirements to install to use the base functionality, a
pip install -r plugin_requirements.txt
```

## Note on Github Branches
Unless there's glaring bugs present, I will work solely on the ```dev``` branch in between releases. As such, pulling from ```master``` should be safe from my on-going work that might break things.

# Usage
The most common use-case is to initialise a ```Database``` object, just like you would with sqlite3.

Expand Down Expand Up @@ -237,4 +240,4 @@ Benchmarks are similarly run:

```bash
python -m benchmarks
```
```

0 comments on commit 11b5d7b

Please sign in to comment.