From d5532053569fbf802e81a32891a26283240d98ff Mon Sep 17 00:00:00 2001 From: Muthu Kumar Date: Wed, 11 Apr 2018 11:26:19 +0530 Subject: [PATCH] [docs] Updated README --- .gitignore | 2 +- README.md | 17 ++++++++++++----- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/.gitignore b/.gitignore index 96dba9b..5318ae9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,6 @@ # Test File testscript.js - +jsdoc-template # Logs logs *.log diff --git a/README.md b/README.md index a38e0d2..03eefef 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,10 @@ ## Usage +### Fuse + ```JavaScript const Fuse = require('@codefeathers/fuse'); -const { FuseIterable } = require('@codefeathers/fuse'); const a = 100; @@ -19,11 +20,17 @@ const result = new Fuse(a) .on(x => x===10, a => `${a} is 10.`) -console.log(result.resolve()); +console.log(result.resolve()); // -> "100 is greater than 10." +``` + +### FuseIterable + +```JavaScript +const { FuseIterable } = require('@codefeathers/fuse'); -const arr = [ 0, 20, 30 ]; +const temperatures = [ 0, 20, 30 ]; -const temperature = new FuseIterable(arr) +const result = new FuseIterable(temperatures) .on(temp => temp<10, () => `Too cold!`) .on(temp => temp>=10 && temp <25, @@ -31,7 +38,7 @@ const temperature = new FuseIterable(arr) .on(temp => temp>=25, () => `Too warm!`) -console.log(temperature.resolve()); // -> [ "Too cold!", "Just right.", "Too warm!" ] +console.log(result.resolve()); // -> [ "Too cold!", "Just right.", "Too warm!" ] ``` ## Docs