diff --git a/README.md b/README.md index 777dd5c..ed6ef56 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ -# booler -Convert string to Boolean in JavaScript. +# Booler: Convert any values to Boolean. + +Convert string/values to Boolean in JavaScript. + +# Installing + +# Example + +```js +const booler = require('booler') + +console.log(booler('f')) // return false +console.log(booler('t')) // return true +``` + +# Run Test + +```shell +$ npm run test +```