diff --git a/README.md b/README.md index 2a4cfe3e..bbdcf634 100644 --- a/README.md +++ b/README.md @@ -342,7 +342,7 @@ The following parameters can be passed for more sophisticated searches;
limit
the maximum number of results to return
q
the query to run (e.g, subject:hello). If not specified, the default field is searched.
skip
the number of results to skip
-
sort
the comma-separated fields to sort on. Prefix with / for ascending order and \ for descending order (ascending is the default if not specified). Type-specific sorting is also available by appending a : and the sort type as normal (e.g, 'sort=amount:float').
+
sort
the comma-separated fields to sort on. Prefix with / for ascending order and \ for descending order (ascending is the default if not specified). Type-specific sorting is also available by appending a : and the sort type as normal (e.g, 'sort=amount:float'). Supported types are 'float', 'double', 'int', 'long' and 'date'.
stale=ok
If you set the stale option to ok, couchdb-lucene may not perform any refreshing on the index. Searches may be faster as Lucene caches important data (especially for sorting). A query without stale=ok will use the latest data committed to the index.