update readme to add ideal api

Author: amilajack

README.md

@@ -1,10 +1,42 @@
 # Parallel.js
 
+[![Build Status](https://travis-ci.org/parallel-js/parallel.js.svg?branch=master)](https://travis-ci.org/parallel-js/parallel.js)
+
+## Idea
+
+```js
+import { Jobs, ParallelArray } from 'paralleljs';
+
+// Execute multiple jobs in parallel and asynchrnously
+const jobs = new Jobs();
+const [job1, job2, job3] = await jobs.all([
+  () => fibonacci(1),
+  gaussianSumm,
+  foobar
+]);
+console.log(job1, job2, job3);
+
+// An array with all methods parallelized
+const array = new ParallelArray([1, 2, 3]);
+array.push(1);
+array.map(e => e + 1);
+array.filter(e => !!e);
+```
+
+## Local Development
+
+```bash
+git clone https://github.com/parallel-js/parallel.js
+cd parallel.js
+yarn
+yarn test
+```
+
 ## Contributors
 
 Parallel.js is made up of four contributors:
 
-[Adam Savitzky (Adam)](https://github.com/adambom)
-[Mathias Rangel Wulff (Mathias)](https://github.com/mathiasrw)
-[Amila Welihinda (amilajack)](https://github.com/amilajack)
-[MaXwell Falstein (MaX)](https://github.com/MaXwellFalstein)
+* [Adam Savitzky (Adam)](https://github.com/adambom)
+* [Mathias Rangel Wulff (Mathias)](https://github.com/mathiasrw)
+* [Amila Welihinda (amilajack)](https://github.com/amilajack)
+* [MaXwell Falstein (MaX)](https://github.com/MaXwellFalstein)

package.json

@@ -39,7 +39,8 @@
     "babel-core": "^7.0.0-0",
     "babel-jest": "^23.6.0",
     "eslint": "^5.9.0",
-    "eslint-config-bliss": "^3.1.1"
+    "eslint-config-bliss": "^3.1.1",
+    "jest": "^23.6.0"
   },
   "eslintConfig": {
     "extends": [

test/basic.spec.js

@@ -1,20 +1,34 @@
-const Parallel = require('..');
+const { ParallelArray, Jobs } = require('..');
+
+const fibonacci = () => {};
+const gaussianSumm = () => {};
+const foobar = () => {};
 
 describe('basic', () => {
   it('should construct object', () => {
-    new Parallel([]);
-    new Parallel();
+    new ParallelArray([]);
+    new ParallelArray();
   });
 
   it('should take expected arguments', () => {
-    const array = new Parallel();
+    const array = new ParallelArray();
     array.push(1);
     array.push(2);
   });
 
   it('should call parallel methods', () => {
-    const array = new Parallel();
+    const array = new ParallelArray();
     array.map(e => e + 1);
     array.filter(e => !!e);
   });
+
+  it('should call execute jobs in parallel', async () => {
+    const jobs = new Jobs();
+    const [job1, job2, job3] = await jobs.all([
+      () => fibonacci(1),
+      gaussianSumm,
+      foobar
+    ]);
+    console.log(job1, job2, job3);
+  });
 });