Merge pull request #25 from Sykander/for-each-docs

For Each Docs

Author: Sykander

README.md

@@ -1,28 +1,21 @@
-# Iterable Async Methods
+# Iterable Async Methods 
+[![Try iterable-async on RunKit](https://badge.runkitcdn.com/iterable-async.svg)](https://npm.runkit.com/iterable-async)
 
 A collection of methods for looping iterable objects asynchronously using something similar to the Array api.
 
-## Methods
-
-* Async Map
-* Async For Each
-* Async Filter
-* Async Find
-* Async Find Index
-
-### Async Map
+## Installation
 
-Map an iterable object asynchronously
 ```
-function asyncMap(callback, [thisArg]) {...}
+$ npm install iterable-async
 ```
 
-### Async For Each
+## Methods
 
-Loop over an iterable object asynchronously
-```
-function asyncForEach(callback, [thisArg]) {...}
-```
+* Async Filter
+* Async Find
+* Async Find Index
+* Async For Each
+* Async Map
 
 ### Async Filter 
 
@@ -42,9 +35,24 @@ function asyncFind(callback, [thisArg]) {...}
 
 Find an item's index in an iterable object asynchronously
 ```
-function asyncFindIndex(callback, [thisArg]) {...}
+async function asyncFindIndex(callback, [thisArg]) {...}
+```
+
+### [Async For Each](https://github.com/Sykander/iterable-async/wiki/Async-For-Each)
+
+Loop over an iterable object asynchronously
+```
+function asyncForEach(callback, [thisArg]) {...}
 ```
 
+### Async Map
+
+Map an iterable object asynchronously
+```
+function asyncMap(callback, [thisArg]) {...}
+```
+
+
 ## Development
 
 Development is open to contribution, check the project board "Development" for tickets.

docs/playground.js

@@ -0,0 +1,7 @@
+const {
+	asyncFind,
+	asyncFindIndex,
+	asyncFilter,
+	asyncForEach,
+	asyncMap
+} = require('iterable-async');

package.json

@@ -5,7 +5,7 @@
   "main": "src",
   "scripts": {
     "test": "./node_modules/.bin/mocha test",
-    "lint:fix": "./node_modules/.bin/eslint src test --fix && ./node_modules/.bin/prettier --write 'src/**/*.{js,ts,css,html}' --write 'test/**/*.{js,ts,css,html}'",
+    "lint:fix": "./node_modules/.bin/prettier --write 'src/**/*.{js,ts,css,html}' --write 'test/**/*.{js,ts,css,html}' --write 'docs/**/*.{js,ts,css,html}'",
     "lint:check": "./node_modules/.bin/eslint src test",
     "lint": "npm run lint:fix && npm run lint:check",
     "prepublishOnly": "npm run lint:check && npm test"
@@ -34,5 +34,6 @@
     "hooks": {
       "pre-commit": "npm run lint:check"
     }
-  }
+  },
+  "runkitExampleFilename": "docs/playground.js"
 }