Permalink
Browse files

more doc tweaks

  • Loading branch information...
1 parent 04e99c0 commit 8c23e4fc5288e74e9778be115b64e32a57b1a7f0 @erwaller erwaller committed Feb 14, 2011
Showing with 10 additions and 7 deletions.
  1. +10 −7 README.markdown
View
17 README.markdown
@@ -20,23 +20,25 @@ Where `id` is a unique identifier (within the specific type), `term` is the phra
Getting Started
---------------
-You can load data into Soulmate by piping items into `soulmate load`.
+As always,
-Here's a sample `venues.json` (in the JSON lines format -- i.e. one JSON item per line):
+You can load data into Soulmate by piping items the JSON lines format into `soulmate load`.
+
+Here's a sample `venues.json` (one JSON item per line):
{"id":1,"term":"Dodger Stadium","score":85,"data":{"url":"\/dodger-stadium-tickets\/","subtitle":"Los Angeles, CA"}}
{"id":28,"term":"Angel Stadium","score":85,"data":{"url":"\/angel-stadium-tickets\/","subtitle":"Anaheim, CA"}}
{"id":30,"term":"Chase Field ","score":85,"data":{"url":"\/chase-field-tickets\/","subtitle":"Phoenix, AZ"}}
{"id":29,"term":"Sun Life Stadium","score":84,"data":{"url":"\/sun-life-stadium-tickets\/","subtitle":"Miami, FL"}}
{"id":2,"term":"Turner Field","score":83,"data":{"url":"\/turner-field-tickets\/","subtitle":"Atlanta, GA"}}
-And the load command (with redis running locally on the default port, or specify a redis connection string with the `--redis` argument):
+And here's the load command (Soulmate assumes redis is running locally on the default port, or you can specify a redis connection string with the `--redis` argument):
$ soulmate load venue --redis=redis://localhost:6379/0 < venues.json
Once it's loaded, we can query this data by starting `soulmate-web`:
- $ soulmate-web --foreground --redis=redis://localhost:6379/0 --no-launch
+ $ soulmate-web --foreground --no-launch --redis=redis://localhost:6379/0
And viewing the service in your browser: <a href="http://localhost:5678/search?types[]=venue&term=stad">http://localhost:5678/search?types[]=venue&term=stad</a>. You should see something like:
@@ -75,17 +77,18 @@ And viewing the service in your browser: <a href="http://localhost:5678/search?t
}
}
-== Contributing to soulmate
+Contributing to soulmate
+------------------------
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
* Fork the project
* Start a feature/bugfix branch
* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-== Copyright
+Copyright
+---------
Copyright (c) 2011 Eric Waller. See LICENSE.txt for
further details.

0 comments on commit 8c23e4f

Please sign in to comment.