From e38b450761af59496f61bd885d021597882f04ea Mon Sep 17 00:00:00 2001 From: Muthu Kumar Date: Wed, 11 Apr 2018 10:57:01 +0530 Subject: [PATCH] [docs] Updated README for Fuse --- README.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index a20a108..f2d70fb 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,22 @@ -# select-return +# Fuse +**FunctionSelect** -Return a function based on a condition. Functional alternative to switch-case. +`Fuse` selects a function that passes a condition. ## Usage ```JavaScript +const Fuse = require('@codefeathers/fuse'); +const { FuseIterable } = require('@codefeathers/fuse'); + const a = 100; -const result = new Select(a) - .for(x => x>10, +const result = new Fuse(a) + .on(x => x>10, a => `${a} is greater than 10.`) - .for(x => x<10, + .on(x => x<10, a => `${a} is lesser than 10.`) - .for(x => x===10, + .on(x => x===10, a => `${a} is 10.`) console.log(result.resolve()); // -> "100 is greater than 10." @@ -24,17 +28,15 @@ Docs exist in `/docs` directory. Will be served soon. ## Development -> If you find any mistakes in code/documentation, or if you feel something could be done better, do PR :) - -> I appreciate it. +> If you find any mistakes in code/documentation, or if you feel something could be done better, do PR :) I appreciate it. - Always write test spec for any code you add. Make sure they run as intended. - Add/update JSDoc comments as needed. -- Use npm scripts for linting, debugging, building docs. +- Use npm scripts for linting, tests, debugging, building docs. Place your test file as `testscript.js` in root. -The following npm scripts are available: `npm run lint`, `npm run debug`, `npm run docs`. +The following npm scripts are available: `npm run lint`, `npm test`, `npm run debug`, `npm run docs`. ## Credits