update doc

Author: dethi

README.md

@@ -21,6 +21,7 @@ Table of Content
 1. [Commands](#commands)
 1. [Search](#search)
 1. [Geo-search](#geo-search)
+1. [Tags](#tags)
 1. [Options](#options)
 
 
@@ -96,13 +97,22 @@ And then replace `algoliasearch.register(YourModel)` with `algoliasearch.registe
 
 We recommend the usage of our [JavaScript API Client](https://github.com/algolia/algoliasearch-client-js) to perform queries directly from the end-user browser without going through your server.
 
+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.
+
+```python
+from django.contrib.algoliasearch import raw_search
+
+params = { "hitsPerPage": 5 }
+raw_search(Contact, "jim", params)
+```
+
 ## Geo-Search
 
 Use the `geo_field` attribute to localize your record. `geo_field` should be a callable that returns a tuple (latitude, longitude).
 
 ```python
 class Contact(models.model):
-    name = models.CharField()
+    name = models.CharField(max_lenght=20)
     lat = models.FloatField()
     lng = models.FloatField()
 
@@ -160,3 +170,19 @@ class ArticleIndex(AlgoliaIndex):
         'customRanking': ['desc(vote_count)', 'asc(name)']
     }
 ```
+
+## Restrict indexing to a subset of your data
+
+You can add constraints controlling if a record must be indexed or not. `should_index` should be a callable that returns a boolean.
+
+```python
+class Contact(models.model):
+    name = models.CharField(max_lenght=20)
+    age = models.IntegerField()
+
+    def is_adult(self):
+        return (self.age >= 18)
+
+class ContactIndex(AlgoliaIndex):
+    should_index = 'is_adult'
+```

src/__init__.py

@@ -6,11 +6,12 @@
 from __future__ import unicode_literals
 
 from django.contrib.algoliasearch.models import AlgoliaIndex
-from django.contrib.algoliasearch.registration import AlgoliaEngine, algolia_engine
+from django.contrib.algoliasearch.registration import AlgoliaEngine
+from django.contrib.algoliasearch.registration import algolia_engine
 
 algolia_engine = algolia_engine
 register = algolia_engine.register
 unregister = algolia_engine.unregister
 get_registered_model = algolia_engine.get_registered_models
 get_adapter = algolia_engine.get_adapter
-search = algolia_engine.search
+raw_search = algolia_engine.raw_search

src/models.py

@@ -38,7 +38,7 @@ class AlgoliaIndex(object):
     settings = {}
 
     # Use to specify a callable that say if the instance should be indexed.
-    # The attribute should be a callable that returns a booleen.
+    # The attribute should be a callable that returns a boolean.
     should_index = None
 
     # Instance of the index from algoliasearch client
@@ -187,7 +187,7 @@ def delete_obj_index(self, instance):
         self.__index.delete_object(objectID)
         logger.debug('DELETE %s FROM %s', objectID, self.model)
 
-    def search(self, query='', params={}):
+    def raw_search(self, query='', params={}):
         return self.__index.search(query, params)
 
     def set_settings(self):

src/registration.py

@@ -103,9 +103,9 @@ def delete_obj_index(self, obj):
         adapter = self.get_adapter_from_instance(obj)
         adapter.delete_obj_index(obj)
 
-    def search(self, model, query='', params={}):
+    def raw_search(self, model, query='', params={}):
         adapter = self.get_adapter(model)
-        return adapater.search(query, params)
+        return adapater.raw_search(query, params)
 
     # Signalling hooks.