Skip to content

Commit e398152

Browse files
committed
fix: Update Readme to match latest changes
chore: Fix code sample, bump version to v1.3.1
1 parent 2a3c265 commit e398152

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ pip install algoliasearch-django
7272

7373
## Setup
7474

75-
In your Django settings, add `django.contrib.algoliasearch` to `INSTALLED_APPS` and add these two settings:
75+
In your Django settings, add `algoliasearch_django` to `INSTALLED_APPS` and add these two settings:
7676

7777
```python
7878
ALGOLIA = {
@@ -93,7 +93,7 @@ Simply call `algoliasearch.register()` for each of the models you want to index.
9393

9494
```python
9595
from django.apps import AppConfig
96-
from django.contrib import algoliasearch
96+
import algoliasearch_django as algoliasearch
9797

9898
class YourAppConfig(AppConfig):
9999
name = 'your_app'
@@ -112,7 +112,7 @@ default_app_config = 'your_django_app.apps.YourAppConfig'
112112
By default, all the fields of your model will be used. You can configure the index by creating a subclass of `AlgoliaIndex`. A good place to do this is in a separate file, like `index.py`.
113113

114114
```python
115-
from django.contrib.algoliasearch import AlgoliaIndex
115+
from algoliasearch_django import AlgoliaIndex
116116

117117
class YourModelIndex(AlgoliaIndex):
118118
fields = ('name', 'date')
@@ -147,7 +147,7 @@ We recommend the usage of our [JavaScript API Client](https://github.com/algolia
147147
However, if you want to search from your backend you can use the `raw_search(YourModel, 'yourQuery', params)` method. It retrieves the raw JSON answer from the API.
148148

149149
```python
150-
from django.contrib.algoliasearch import raw_search
150+
from algoliasearch_django import raw_search
151151

152152
params = { "hitsPerPage": 5 }
153153
raw_search(Contact, "jim", params)

algoliasearch_django/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
VERSION = '1.3.0'
1+
VERSION = '1.3.1'

0 commit comments

Comments
 (0)