From 8443d20e99a478fd7daefabaad5cc5ee318061a5 Mon Sep 17 00:00:00 2001
From: Kirollos Risk <krisk@linkedin.com>
Date: Tue, 8 Apr 2014 16:58:25 -0700
Subject: [PATCH] Fixed README

---
 README.md | 42 +++++++++++-------------------------------
 1 file changed, 11 insertions(+), 31 deletions(-)

diff --git a/README.md b/README.md
index dd1ba90ad..f70742091 100644
--- a/README.md
+++ b/README.md
@@ -9,8 +9,7 @@ Visit here for usage, demo, and more: [Fuse](http://kiro.me/projects/fuse.html)
 
 ## Options
 
-**keys**
-*Type*: `Array`
+**keys** (*type*: `Array`)
 
 List of properties that will be searched.  This also supports nested properties:
 
@@ -27,40 +26,31 @@ var fuse = new Fuse(boos, { keys: ["title", "author.firstName"] });
 
 ---
 
-**id**
-*Type*: `String`
+**id** (*type*: `String`)
 
 The string name of the identifier property. If specified, the returned result will be a list of the items' identifiers, otherwise it will be a list of the items.
 
 ---
 
-**caseSensitive**
-*Type*: `Boolean`
-*Default*: `false`
+**caseSensitive** (*type*: `Boolean`, *default*: `false`)
 
 Indicates whether comparisons should be case sensitive.
 
 ---
 
-**includeScore**
-*Type*: `Boolean`
-*Default*: `true`
+**includeScore** (*type*: `Boolean`, *default*: `true`)
 
 Whether the score should be included in the result set. When `true`, each result in the list will be of the form `{ item: ..., score: ... }`
 
 ---
 
-**shouldSort**
-*Type*: `Boolean`
-*Default*: `true`
+**shouldSort** (*type*: `Boolean`, *default*: `true`)
 
 Whether to sort the result list, by score.
 
 ---
 
-**searchFn**
-*Type*: `Function`
-*Default*: `BitapSearcher` (internal)
+**searchFn** (*type*: `Function`, *default*: `BitapSearcher`)
 
 The search function to use.  Note that the search function (`[[Function]]`) must conform the following API:
 
@@ -82,41 +72,31 @@ The search function to use.  Note that the search function (`[[Function]]`) must
 
 ---
 
-**sortFn**
-*Type*: `Function`
-*Default*: `Array.prototype.sort`
+**sortFn** (*type*: `Function`, *default*: `Array.prototype.sort`)
 
 The function that is used for sorting the result list.
 
 ### Bitap specific options
 
-**location**
-*Type*: `Integer`
-*Default*: `0`
+**location** (*type*: `Integer`, *default*: `0`)
 
 Determines approximately where in the text is the pattern expected to be found.
 
 ---
 
-**threshold**
-*Type*: `Decimal`
-*Default*: `0.6`
+**threshold** (*type*: `Decimal`, *default*: `0.6`)
 
 At what point does the match algorithm give up. A threshold of `0.0` requires a perfect match (of both letters and location), a threshold of `1.0` would match anything.
 
 ---
 
-**distance**
-*Type*: `Integer`
-*Default*: `100`
+**distance** (*type*: `Integer`, *default*: `100`)
 
 Determines how close the match must be to the fuzzy location (specified by `location`). An exact letter match which is `distance` characters away from the fuzzy location would score as a complete mismatch. A `distance` of `0` requires the match be at the exact `location` specified, a `threshold` of `1000` would require a perfect match to be within 800 characters of the `location` to be found using a `threshold` of `0.8`.
 
 ---
 
-**maxPatternLength**
-*Type*: `Integer`
-*Default*: `32`
+**maxPatternLength** (*type*: `Integer`, *default*: `32`)
 
 The maximum length of the pattern. The longer the pattern, the more intensive the search operation will be.  Whenever the pattern exceeds the `maxPatternLength`, an error will be thrown.  Why is this important? Read [this](http://en.wikipedia.org/wiki/Word_(computer_architecture)#Word_size_choice).