Skip to content

Commit d8520b6

Browse files
feat(readme): adds docs
adds docs as a (feat) in order to bump version and force release
1 parent 48a4f89 commit d8520b6

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,25 @@
33
![Travis build](https://img.shields.io/travis/johnptmcdonald/tinyhelp)
44
![Code Coverage](https://img.shields.io/codecov/c/github/johnptmcdonald/tinyhelp)
55

6+
Install like this:
7+
`npm i tinyhelp`
8+
9+
Then either import everything:
10+
11+
```
12+
import * as helpMe from "tinyhelp";
13+
helpMe.sort([5,2,6,3,5]); // => [2,3,5,5,6]
14+
helpMe.flatten([1,[2,[3]]]) // => [1,2,3]
15+
```
16+
17+
Or use named imports:
18+
19+
```
20+
import { sort } from "tinyhelp";
21+
sort([5,2,6,3,5]) // => [2,3,5,5,6]
22+
23+
```
24+
625
This is a tiny library of javascript functions, currently comprising:
726

827
- deepCopy

0 commit comments

Comments
 (0)