From ed87c36fce3ae80f3d07c35d7f83187da18b89d6 Mon Sep 17 00:00:00 2001 From: YPCrumble Date: Fri, 6 Jan 2017 10:09:54 -0500 Subject: [PATCH] Add documentation for caseSensitive option. --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d3b7887..7c82cab 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ Browser: ## Use it -Padawan: Simply filter an array of strings. +Initiate: Simply filter an array of strings. ```javascript var list = ['baconing', 'narwhal', 'a mighty bear canoe']; @@ -45,6 +45,23 @@ console.log(matches); // [ 'baconing', 'a mighty bear canoe' ] ``` +Padawan: Match case-sensitive strings (defaults to `false`) + +```javascript +var list = ['baconing', 'narwhal', 'a Mighty Bear canoe']; +var options = { caseSensitive: true }; +var results_lower = fuzzy.filter('bcn', list, options) +console.log(results_lower); +// [ +// {string: 'aoing' , index: 0, score: 3, original: 'baconing'}, +// ] +var results_upper = fuzzy.filter('Bcn', list, options) +console.log(results_upper); +// [ +// {string: 'a mighty ear aoe', index: 2, score: 3, original: 'a Mighty Bear canoe'} +// ] +``` + Jedi: Wrap matching characters in each string ```javascript