Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Added docs about filtering

  • Loading branch information...
commit 81946ca9ff8f4ca2258025c7a5b4b5e06da57df1 1 parent c745943
@rixth rixth authored
Showing with 6 additions and 0 deletions.
  1. +6 −0 README.markdown
View
6 README.markdown
@@ -93,6 +93,12 @@ And viewing the service in your browser: <a href="http://localhost:5678/search?t
The `/search` method supports multiple `types` as well as an optional `limit`. For example: `http://localhost:5678/search?types[]=event&types[]=venue&types[]=performer&limit=3&term=yank`.
+### Filterable data
+
+If you want your data to be filterable by other arbitrary values, you can add them to a key called filterable as a hash in the format of indexName:value. This is useful when your items fall in to a number of discrete buckets, like zip code or city and you want to be able to narrow your results.
+
+You can specify filters in your URL to the server in the form of `filters[type][indexName]=value`, eg. `http://localhost:5678/search?types[]=event&filters[event][state]=CA&term=yank` to find events in California.
+
Contributing to soulmate
------------------------
Please sign in to comment.
Something went wrong with that request. Please try again.