diff --git a/readme.md b/readme.md index e89a495..f64eb1c 100644 --- a/readme.md +++ b/readme.md @@ -1,7 +1,7 @@ # read-file-json -License Sponsor read-file-json +License Sponsor read-file-json Build status Commits since v1.0.1 Last commit Issues Latest version on npm Dependents Downloads @@ -11,24 +11,43 @@ +## Installation +read-file-json on npm +```bash +npm install --save read-file-json@^1.0.1 +``` +read-file-json on Yarn +```bash +yarn add read-file-json@^1.0.1 +``` +@jaid/read-file-json on GitHub Packages +(if [configured properly](https://help.github.com/en/github/managing-packages-with-github-packages/configuring-npm-for-use-with-github-packages)) +```bash +npm install --save @jaid/read-file-json@^1.0.1 +``` +## Example -## Installation -read-file-json on npm -```bash -npm install --save read-file-json@^1.0.1 +```javascript +import readFileJson from "read-file-json" + +readFileJson("./doesNotExist.json5").then(result => { + +}) ``` -read-file-json on Yarn -```bash -yarn add read-file-json@^1.0.1 + +Variable `result` will now be: + +```javascript +null ``` @@ -37,6 +56,12 @@ yarn add read-file-json@^1.0.1 + + + + + + ## Development