Skip to content

Commit 6533665

Browse files
committed
fix typo README
1 parent b2b07c7 commit 6533665

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
Algolia Search for Django
22
==================
33

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.
55

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)
77

88
Compatible with **Python 2.7**, **Python 3.2+** and **Django 1.7+**
99

@@ -35,7 +35,7 @@ pip install algoliasearch-django
3535
Setup
3636
-------------
3737

38-
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:
3939

4040
```python
4141
ALGOLIA = {
@@ -44,16 +44,16 @@ ALGOLIA = {
4444
}
4545
```
4646

47-
There is also two optionals settings that take a string:
47+
There are two optional settings:
4848

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`.
5151

5252

5353
Quick Start
5454
-------------
5555

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/)
5757

5858
```python
5959
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
7373
default_app_config = 'your_django_app.apps.YourAppConfig'
7474
```
7575

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 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`.
7777

7878
```python
7979
from django.contrib.algoliasearch import AlgoliaIndex
@@ -161,7 +161,7 @@ class ContactIndex(algoliaindex):
161161

162162
## Index settings
163163

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).
165165

166166
```python
167167
class ArticleIndex(AlgoliaIndex):

0 commit comments

Comments
 (0)