docs(readme): Add API section in Readme

close #7
VovanR · Jan 24, 2018 · 4341086 · 4341086
1 parent 8df6408
commit 4341086
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -36,6 +36,25 @@ toggleInArray(
 //=> [{v: 1}, {v: 3}]
 ```
 
+## API
+
+### `toggleInArray(arr, value, [predicate])`
+
+Returns an `Array` with `value` if `arr` is not includes this `value`<br>
+Returns an `Array` without `value` if `arr` is includes this `value`
+
+#### arr
+*Required*<br>
+Type: `Array`
+
+#### value
+*Required*<br>
+Type: `Array`
+
+#### predicate
+Type: `Function`<br>
+Default: `(a, b) => a === b` *Strict equality comparison*
+
 ## License
 MIT © [Vladimir Rodkin](https://github.com/VovanR)