Skip to content

Commit 042f7f8

Browse files
committed
build readme
1 parent 17cc24c commit 042f7f8

File tree

2 files changed

+18
-28
lines changed

2 files changed

+18
-28
lines changed

.verb.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,20 @@
44
55
Why another array `difference` lib? I wanted the [fastest, correct implementation](./benchmark) I could find.
66

7-
## Install
87
{%= include("install-npm", {save: true}) %}
98
{%= include("install-bower", {save: true}) %}
109

10+
## Usage
11+
12+
{%= comments("index.js") %}
13+
14+
1115
## Run tests
1216

1317
```bash
1418
npm test
1519
```
1620

17-
## Usage
18-
19-
```js
20-
var diff = require('{%= name %}');
21-
```
22-
23-
## API
24-
{%= comments("index.js") %}
25-
26-
2721
## Author
2822
{%= include("author") %}
2923

README.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# arr-diff [![NPM version](https://badge.fury.io/js/arr-diff.svg)](http://badge.fury.io/js/arr-diff) [![Build Status](https://travis-ci.org/jonschlinkert/arr-diff.svg)](https://travis-ci.org/jonschlinkert/arr-diff)
22

3-
> Return an array with only the unique values present in all given arrays using strict equality for comparisons.
3+
> Returns an array with only the unique values from the first array, by excluding all values from additional arrays using strict equality for comparisons.
44
55
Why another array `difference` lib? I wanted the [fastest, correct implementation](./benchmark) I could find.
66

7-
## Install
87
## Install with [npm](npmjs.org)
98

109
```bash
@@ -16,37 +15,34 @@ npm i arr-diff --save
1615
bower install arr-diff --save
1716
```
1817

19-
## Run tests
20-
21-
```bash
22-
npm test
23-
```
24-
2518
## Usage
2619

27-
```js
28-
var diff = require('arr-diff');
29-
```
30-
31-
## API
32-
### [diff](index.js#L33)
20+
### [diff](index.js#L38)
3321

34-
Return the difference between two arrays.
22+
Return the difference between the first array and additional arrays.
3523

3624
* `a` **{Array}**
3725
* `b` **{Array}**
3826
* `returns`: {Array}
3927

4028
```js
29+
var diff = require('{%= name %}');
30+
4131
var a = ['a', 'b', 'c', 'd'];
4232
var b = ['b', 'c'];
4333

44-
console.log(difference(a, b))
34+
console.log(diff(a, b))
4535
//=> ['a', 'd']
4636
```
4737

4838

4939

40+
## Run tests
41+
42+
```bash
43+
npm test
44+
```
45+
5046
## Author
5147

5248
**Jon Schlinkert**
@@ -82,4 +78,4 @@ Released under the MIT license
8278

8379
***
8480

85-
_This file was generated by [verb](https://github.com/assemble/verb) on December 01, 2014._
81+
_This file was generated by [verb](https://github.com/assemble/verb) on December 28, 2014._

0 commit comments

Comments
 (0)