Skip to content

Commit 69c324f

Browse files
committed
Rebuilt readme with tldw
1 parent 1868b0e commit 69c324f

File tree

1 file changed

+18
-25
lines changed

1 file changed

+18
-25
lines changed

readme.md

Lines changed: 18 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,25 @@ npm install --save @jaid/read-file-json@^1.0.2
3636

3737
## Example
3838

39+
3940
```javascript
4041
import readFileJson from "read-file-json"
4142

42-
readFileJson("./doesNotExist.json5").then(result => {
43+
readFileJson("./exists.json5").then(result => {
44+
45+
})
46+
47+
readFileJson("./doesNotExist.json5").then(result2 => {
4348

4449
})
4550
```
4651

47-
Variable `result` will now be:
52+
Variable `result` will be:
53+
54+
```javascript
55+
["a", "b", "c"]
56+
```
57+
Variable `result2` will be:
4858

4959
```javascript
5060
null
@@ -62,6 +72,10 @@ null
6272

6373

6474

75+
76+
77+
78+
6579
## Development
6680

6781

@@ -83,26 +97,5 @@ npm run test
8397

8498

8599
## License
86-
```text
87-
MIT License
88-
89-
Copyright © 2020, Jaid <jaid.jsx@gmail.com> (github.com/jaid)
90-
91-
Permission is hereby granted, free of charge, to any person obtaining a copy
92-
of this software and associated documentation files (the "Software"), to deal
93-
in the Software without restriction, including without limitation the rights
94-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
95-
copies of the Software, and to permit persons to whom the Software is
96-
furnished to do so, subject to the following conditions:
97-
98-
The above copyright notice and this permission notice shall be included in all
99-
copies or substantial portions of the Software.
100-
101-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
102-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
103-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
104-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
105-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
106-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
107-
SOFTWARE.
108-
```
100+
[MIT License](https://raw.githubusercontent.com/jaid/read-file-json/master/license.txt)
101+
Copyright © 2021, Jaid \<jaid.jsx@gmail.com> (https://github.com/jaid)

0 commit comments

Comments
 (0)