Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

more doc tweaks

  • Loading branch information...
commit 8ede26a974725d1dfa9c9849f599dce346c41cc5 1 parent 8c23e4f
@erwaller erwaller authored
Showing with 11 additions and 1 deletion.
  1. +11 −1 README.markdown
View
12 README.markdown
@@ -17,10 +17,16 @@ Soulmate can offer suggestions for multiple types of items in a single query. An
Where `id` is a unique identifier (within the specific type), `term` is the phrase you wish to provide completions for, `score` is a user-specified ranking metric (redis will order things lexigraphically for items with the same score), and `data` is an optional container for metadata you'd like to return when this item is matched (at SeatGeek we're including a url for the item as well as a subtitle for when we present it in an autocomplete dropdown).
+See Soulmate in action at <a href="http://seatgeek.com/">SeatGeek</a>.
+
Getting Started
---------------
-As always,
+As always, kick things off with a `gem install`:
+
+ gem install soulmate
+
+### Loading Items
You can load data into Soulmate by piping items the JSON lines format into `soulmate load`.
@@ -36,6 +42,8 @@ And here's the load command (Soulmate assumes redis is running locally on the de
$ soulmate load venue --redis=redis://localhost:6379/0 < venues.json
+### Querying for Data
+
Once it's loaded, we can query this data by starting `soulmate-web`:
$ soulmate-web --foreground --no-launch --redis=redis://localhost:6379/0
@@ -77,6 +85,8 @@ 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`.
+
Contributing to soulmate
------------------------
Please sign in to comment.
Something went wrong with that request. Please try again.