You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
1
Algolia Search for Django
2
2
==================
3
3
4
-
This package let you easily integrate the Algolia Search API to your favorite ORM. It's based on the [algoliasearch-client-python](https://github.com/algolia/algoliasearch-client-python) package.
4
+
This package lets you easily integrate the Algolia Search API to your [Django](https://www.djangoproject.com/) project. It's based on the [algoliasearch-client-python](https://github.com/algolia/algoliasearch-client-python) package.
5
5
6
-
You might be interested in the sample Django application providing a typeahead.js based auto-completion and Google-like instant search: [algoliasearch-django-example](https://github.com/algolia/algoliasearch-django-example)
6
+
You might be interested in this sample Django application providing a typeahead.js based auto-completion and Google-like instant search: [algoliasearch-django-example](https://github.com/algolia/algoliasearch-django-example)
7
7
8
8
Compatible with **Python 2.7**, **Python 3.2+** and **Django 1.7+**
In your Django settings, add `django.contrib.algoliasearch` to `INSTALLED_APPS` and add two settings:
38
+
In your Django settings, add `django.contrib.algoliasearch` to `INSTALLED_APPS` and add these two settings:
39
39
40
40
```python
41
41
ALGOLIA= {
@@ -44,16 +44,16 @@ ALGOLIA = {
44
44
}
45
45
```
46
46
47
-
There is also two optionals settings that take a string:
47
+
There are two optional settings:
48
48
49
-
*`INDEX_PREFIX`: prefix all index. You can use it to seperate different application, like `site1_Products` and `site2_Products`.
50
-
*`INDEX_SUFFIX`: suffix all index. You can use it to differenciate development and production environement, like `Location_dev` and `Location_prod`.
49
+
*`INDEX_PREFIX`: prefix all indexes. Use it to separate different applications, like `site1_Products` and `site2_Products`.
50
+
*`INDEX_SUFFIX`: suffix all indexes. Use it to differenciate development and production environment, like `Location_dev` and `Location_prod`.
51
51
52
52
53
53
Quick Start
54
54
-------------
55
55
56
-
Simply call `AlgoliaSearch.register()` for each of the models you want to index. A good place to do this is in your application's AppConfig (generally named `apps.py`).
56
+
Simply call `AlgoliaSearch.register()` for each of the models you want to index. A good place to do this is in your application's AppConfig (generally named `apps.py`). More info in the [documentation](https://docs.djangoproject.com/en/1.8/ref/applications/)
57
57
58
58
```python
59
59
from django.apps import AppConfig
@@ -73,7 +73,7 @@ And then, don't forget the line below in the `__init__.py` file of your Django a
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 separeted file, like `index.py`.
76
+
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`.
77
77
78
78
```python
79
79
from django.contrib.algoliasearch import AlgoliaIndex
@@ -161,7 +161,7 @@ class ContactIndex(algoliaindex):
161
161
162
162
## Index settings
163
163
164
-
We provide many ways to configure your index allowing you to tune your overall index relevancy. All the configuration are explained on [our website](https://www.algolia.com/doc/python#Settings).
164
+
We provide many ways to configure your index allowing you to tune your overall index relevancy. All the configuration is explained on [our website](https://www.algolia.com/doc/python#Settings).
0 commit comments