Skip to content

Commit 07aee5f

Browse files
committed
Add TYPESENSE settings example (#94)
1 parent 956bebe commit 07aee5f

File tree

1 file changed

+34
-4
lines changed

1 file changed

+34
-4
lines changed

README.md

+34-4
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,49 @@
99
![Django Versions](https://img.shields.io/badge/django-%3E%3D3.2-brightgreen)
1010
[![PyPI License](https://img.shields.io/pypi/l/django-typesense.svg)](https://pypi.org/project/django-typesense/)
1111

12-
1312
## What is it?
13+
1414
Faster Django Admin powered by [Typesense](https://typesense.org/)
1515

1616
## Quick Start Guide
17+
1718
### Installation
18-
`pip install django-typesense`
19+
20+
```sh
21+
pip install django-typesense
22+
```
1923

2024
or install directly from github to test the most recent version
2125

22-
`pip install git+https://github.com/Siege-Software/django-typesense.git`
26+
```sh
27+
pip install git+https://github.com/Siege-Software/django-typesense.git
28+
```
29+
30+
### Configuration
2331

24-
Add `django_typesense` to the list of installed apps.
32+
Update your `settings.py` to inlcude the following
33+
34+
- Add `django_typesense` to the list of installed apps.
35+
36+
```py
37+
// settings.py
38+
INSTALLED_APPS = [
39+
...
40+
"django_typesense"
41+
]
42+
```
43+
44+
- Add typesense connection details
45+
46+
```py
47+
// settings.py
48+
...
49+
TYPESENSE = {
50+
"api_key": "xyz",
51+
"nodes": [{"host": "0.0.0.0", "port": "8108", "protocol": "http"}],
52+
"connection_timeout_seconds": 2
53+
}
54+
```
2555

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

0 commit comments

Comments
 (0)