Skip to content

Commit

Permalink
Rebuilt readme with tldw
Browse files Browse the repository at this point in the history
  • Loading branch information
Jaid committed May 23, 2021
1 parent 35dd755 commit 0fd0f53
Showing 1 changed file with 8 additions and 24 deletions.
32 changes: 8 additions & 24 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ npm install --save @jaid/read-file-string@^1.0.4

## Example


```javascript
import readFileString from "read-file-string"

Expand All @@ -44,7 +45,7 @@ readFileString("./doesNotExist.txt").then(result => {
})
```

Variable `result` will now be:
Variable `result` will be:

```javascript
null
Expand All @@ -62,6 +63,10 @@ null







## Development


Expand All @@ -83,26 +88,5 @@ npm run test


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

0 comments on commit 0fd0f53

Please sign in to comment.