Skip to content

Revert "Update readme" #148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 28, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 10 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,36 +6,28 @@ Parallel.js
[![npm](https://img.shields.io/npm/dm/paralleljs.svg?maxAge=2592000)]()


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

> Please note that version 2.1 is 2 years old

> **Update: September 2016**: New forces are put in place to drive the code forward.



Parallel.js is a library for to make parallel computing in Javascript simple. It works in Node.js and in the Web Browser.
Parallel takes advantage of Web Workers for the web, and child processes for Node.

# Installation
For node:
You can download the raw javascript file [here](https://raw.github.com/adambom/parallel.js/master/lib/parallel.js)

```bash
npm install paralleljs --save
```
Just include it via a script tag in your HTML page

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
Parallel.js is also available as a node module:

```html
<script src="parallel.js"></script>
```bash
npm install paralleljs --save
```



# Compatibility
Tested on Node.js 6 and 4

[![browser support](https://ci.testling.com/adambom/parallel.js.png)](https://ci.testling.com/adambom/parallel.js)


# Usage

#### `Parallel(data, opts)`
Expand Down Expand Up @@ -221,6 +213,5 @@ p = new Parallel([1, 2, 3], {
p.map(d => d * global.parallel.a);
```

----

[![Throughput Graph](https://graphs.waffle.io/parallel-js/parallel.js/throughput.svg)](https://waffle.io/parallel-js/parallel.js/metrics/throughput)
# Compatibility
[![browser support](https://ci.testling.com/adambom/parallel.js.png)](https://ci.testling.com/adambom/parallel.js)