Skip to content

Commit 10ab429

Browse files
authored
Update readme (#146)
1 parent 018243e commit 10ab429

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

README.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,36 @@ Parallel.js
66
[![npm](https://img.shields.io/npm/dm/paralleljs.svg?maxAge=2592000)]()
77

88

9-
_Easy Parallel Computing with Javascript_
9+
_Easy multi-core processing with javascript._
1010

1111
> Please note that version 2.1 is 2 years old
1212
1313
> **Update: September 2016**: New forces are put in place to drive the code forward.
1414
15-
16-
1715
Parallel.js is a library for to make parallel computing in Javascript simple. It works in Node.js and in the Web Browser.
1816
Parallel takes advantage of Web Workers for the web, and child processes for Node.
1917

2018
# Installation
21-
You can download the raw javascript file [here](https://raw.github.com/adambom/parallel.js/master/lib/parallel.js)
22-
23-
Just include it via a script tag in your HTML page
24-
25-
Parallel.js is also available as a node module:
19+
For node:
2620

2721
```bash
2822
npm install paralleljs --save
2923
```
3024

25+
Download the last javascript file [here](https://raw.github.com/parallel-js/parallel.js/master/lib/parallel.js) and include it via a script tag in your HTML page
26+
27+
```html
28+
<script src="parallel.js"></script>
29+
```
30+
31+
32+
33+
# Compatibility
34+
Tested on Node.js 6 and 4
35+
36+
[![browser support](https://ci.testling.com/adambom/parallel.js.png)](https://ci.testling.com/adambom/parallel.js)
37+
38+
3139
# Usage
3240

3341
#### `Parallel(data, opts)`
@@ -213,5 +221,6 @@ p = new Parallel([1, 2, 3], {
213221
p.map(d => d * global.parallel.a);
214222
```
215223
216-
# Compatibility
217-
[![browser support](https://ci.testling.com/adambom/parallel.js.png)](https://ci.testling.com/adambom/parallel.js)
224+
----
225+
226+
[![Throughput Graph](https://graphs.waffle.io/parallel-js/parallel.js/throughput.svg)](https://waffle.io/parallel-js/parallel.js/metrics/throughput)

0 commit comments

Comments
 (0)