Update docs

Author: wooorm

package.json

@@ -1,7 +1,7 @@
 {
   "name": "array-iterate",
   "version": "2.0.0",
-  "description": "forEach with the possibility to change the next position",
+  "description": "`Array#forEach()` but it’s possible to define where to move to next",
   "license": "MIT",
   "keywords": [
     "array",

readme.md

@@ -5,37 +5,74 @@
 [![Downloads][downloads-badge]][downloads]
 [![Size][size-badge]][size]
 
-[`Array#forEach()`][foreach] with the possibility to change the next position.
+[`Array#forEach()`][foreach] but it’s possible to define where to move to next.
 
-## Install
+## Contents
+
+*   [What is this?](#what-is-this)
+*   [When should I use this?](#when-should-i-use-this)
+*   [Install](#install)
+*   [Use](#use)
+*   [API](#api)
+    *   [`arrayIterate(values, callbackFn[, thisArg])`](#arrayiteratevalues-callbackfn-thisarg)
+*   [Types](#types)
+*   [Compatibility](#compatibility)
+*   [Security](#security)
+*   [Contribute](#contribute)
+*   [License](#license)
+
+## What is this?
+
+A tiny package that works just like `forEach`, with one small difference.
 
-This package is ESM only: Node 12+ is needed to use it and it must be `import`ed
-instead of `require`d.
+## When should I use this?
 
-[npm][]:
+You can use this if for some weird reason—like I did—you have to sometimes
+skip a few places ahead or backwards when moving through an array.
+
+## Install
+
+This package is [ESM only][esm].
+In Node.js (version 12.20+, 14.14+, or 16.0+), install with [npm][]:
 
 ```sh
 npm install array-iterate
 ```
 
-## Use
+In Deno with [Skypack][]:
 
 ```js
-import {arrayIterate} from 'array-iterate'
+import {arrayIterate} from 'https://cdn.skypack.dev/array-iterate@2?dts'
+```
 
-var isFirst = true
-var thisArg = {hello: 'world'}
+In browsers with [Skypack][]:
+
+```html
+<script type="module">
+  import {arrayIterate} from 'https://cdn.skypack.dev/array-iterate@2?min'
+</script>
+```
 
-arrayIterate([1, 2, 3, 4], callbackFn, thisArg)
+## Use
 
-function callbackFn(value, index, values) {
-  console.log(this, value, index, values)
+```js
+import {arrayIterate} from 'array-iterate'
 
-  if (isFirst && index + 1 === values.length) {
-    isFirst = false
-    return 0
-  }
-}
+let first = true
+
+arrayIterate(
+  [1, 2, 3, 4],
+  (value, index, values) => {
+    console.log(this, value, index, values)
+
+    // Repeat once.
+    if (first && index + 1 === values.length) {
+      first = false
+      return 0
+    }
+  },
+  {hello: 'world'}
+)
 ```
 
 Yields:
@@ -58,37 +95,63 @@ There is no default export.
 
 ### `arrayIterate(values, callbackFn[, thisArg])`
 
-Perform the specified action for each element in an array, so works just like
-[`Array#forEach()`][foreach].
-When `callbackFn` returns a `number`, moves to the element at that index next.
+Perform the specified action for each element in an array (just like
+[`Array#forEach()`][foreach]).
+When `callbackFn` returns a `number`, moves to the element at that index
+next.
 
 ###### Parameters
 
-*   `values` (`Array`-like thing)
-    — Values to iterate over
-*   `callbackFn` ([`Function`][callback])
-    — A function that accepts up to three arguments
+*   `values` (`Array<*>`)
+    — values to iterate over
+*   `callbackFn` (`Function`)
+    — function called for each element, can return the `index` to move to next
 *   `thisArg` (`*`, optional)
-    — An object to which the this keyword can refer in `callbackFn`.
-    If `thisArg` is omitted, `undefined` is used as the `this` value
+    — optional object assigned as `this` in `callbackFn`
+
+###### Returns
+
+`undefined`.
 
 #### `function callbackFn(value, index, values)`
 
 Callback given to `iterate`.
 
 ###### Parameters
 
-*   `value` (`*`) — Current iteration
-*   `index` (`number`) — Position of `value` in `values`
-*   `values` (`Array`-like thing) — Currently iterated over
+*   `this` (`*`)
+    — context object when given as `thisArg` to `arrayIterate` or `undefined`
+*   `value` (`*`)
+    — element in array
+*   `index` (`number`)
+    — index of `value` in `values`
+*   `values` (`Array.<*>`)
+    — list
 
-###### Context
+###### Returns
 
-`thisArg` when given to `arrayIterate` or `undefined`
+`number` or `undefined` — the `index` to move to next.
 
-###### Returns
+## Types
+
+This package is fully typed with [TypeScript][].
+There is also a `CallbackFn` type export that represents the callback function.
+
+## Compatibility
+
+This package is at least compatible with all maintained versions of Node.js.
+As of now, that is Node.js 12.20+, 14.14+, and 16.0+.
+It also works in Deno and modern browsers.
+
+## Security
 
-`number` (optional) — Position to go to next.
+This package is safe, assuming that you don’t create an infinite loop
+by keeping on repeating.
+
+## Contribute
+
+Yes please!
+See [How to Contribute to Open Source][contribute].
 
 ## License
 
@@ -114,10 +177,16 @@ Callback given to `iterate`.
 
 [npm]: https://docs.npmjs.com/cli/install
 
+[skypack]: https://www.skypack.dev
+
 [license]: license
 
 [author]: https://wooorm.com
 
-[foreach]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach
+[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
 
-[callback]: #function-callbackfnvalue-index-values
+[typescript]: https://www.typescriptlang.org
+
+[contribute]: https://opensource.guide/how-to-contribute/
+
+[foreach]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach