Skip to content

Commit

Permalink
Add TYPESENSE settings example (#94)
Browse files Browse the repository at this point in the history
  • Loading branch information
KengoWada committed Nov 8, 2024
1 parent 1d8781e commit 45f9116
Showing 1 changed file with 32 additions and 3 deletions.
35 changes: 32 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,43 @@
Faster Django Admin powered by [Typesense](https://typesense.org/)

## Quick Start Guide

### Installation
`pip install django-typesense`

```sh
pip install django-typesense
```

or install directly from github to test the most recent version

`pip install git+https://github.com/Siege-Software/django-typesense.git`
```sh
pip install git+https://github.com/Siege-Software/django-typesense.git
```

### Configuration

Update your settings to include the following

Add `django_typesense` to the list of installed apps.
- Add `django_typesense` to the list of installed apps.

```py
...
INSTALLED_APPS = [
...
"django_typesense"
]
```

- Add `TYPESENSE` connection details

```py
...
TYPESENSE = {
"api_key": "xyz",
"nodes": [{"host": "0.0.0.0", "port": "8108", "protocol": "http"}],
"connection_timeout_seconds": 2
}
```

Follow this [guide](https://typesense.org/docs/guide/install-typesense.html#option-1-typesense-cloud) to install and run typesense

Expand Down

0 comments on commit 45f9116

Please sign in to comment.