diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..3b0653a --- /dev/null +++ b/.editorconfig @@ -0,0 +1,9 @@ +root = true + +[*] +indent_style = space +indent_size = 4 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = false +insert_final_newline = false \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..096746c --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/node_modules/ \ No newline at end of file diff --git a/.jshintrc b/.jshintrc new file mode 100644 index 0000000..8ab3485 --- /dev/null +++ b/.jshintrc @@ -0,0 +1,3 @@ +{ + "esversion": 6 +} \ No newline at end of file diff --git a/README.md b/README.md index 7df356e..dca2283 100644 --- a/README.md +++ b/README.md @@ -1,91 +1,69 @@ # Isset Helper + **A tiny helper method for Javascript, checking a variable for existence.** Since checking variable types and existence always has been painful in Javascript, validation conditions normally are exhausting. -This module solves this definitely. +This module solves this definitely. --- ## Installation -``` +### as a module + +Install the library through your preferred package manager: + +``` bash $ npm install --save isset-helper # or $ yarn add isset-helper ``` -## Require +Then you can require the module as usual: -```JavaScript +``` JavaScript const isset = require('isset-helper'); ``` -or if you prefer a more object-oriented usage of this method: +### in the browser + +Include _one_ of the following script tags in your pages head: -```JavaScript -const Util = { - isset: require('isset-helper') -} +``` html + + +