Skip to content

Commit a749b8f

Browse files
committed
update docs for 1.1.0
1 parent d2bf9e4 commit a749b8f

File tree

2 files changed

+47
-75
lines changed

2 files changed

+47
-75
lines changed

.verb.md

Lines changed: 9 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,47 +2,25 @@
22

33
> {%= description %}
44
5-
Why another array `difference` lib? I wanted the [fastest, correct implementation](./benchmark) I could find.
6-
5+
## Install
76
{%= include("install-npm", {save: true}) %}
87
{%= include("install-bower", {save: true}) %}
98

10-
## Usage
11-
12-
{%= comments("index.js") %}
9+
## API
10+
{%= apidocs("index.js") %}
1311

12+
## Related projects
13+
{%= related(verb.related.list, {remove: name}) %}
1414

15-
## Run tests
15+
## Running tests
16+
{%= include("tests") %}
1617

17-
```bash
18-
npm test
19-
```
18+
## Contributing
19+
{%= include("contributing") %}
2020

2121
## Author
2222
{%= include("author") %}
2323

24-
25-
### Other javascript/node.js utils
26-
27-
Other projects that I maintain:
28-
29-
- [arr-flatten](https://github.com/jonschlinkert/arr-flatten)
30-
- [arrayify-compact](https://github.com/jonschlinkert/arrayify-compact)
31-
- [compact-object](https://github.com/jonschlinkert/compact-object)
32-
- [delete](https://github.com/jonschlinkert/delete)
33-
- [for-in](https://github.com/jonschlinkert/for-in)
34-
- [for-own](https://github.com/jonschlinkert/for-own)
35-
- [has-any](https://github.com/jonschlinkert/has-any)
36-
- [has-value](https://github.com/jonschlinkert/has-value)
37-
- [is-number](https://github.com/jonschlinkert/is-number)
38-
- [is-plain-object](https://github.com/jonschlinkert/is-plain-object)
39-
- [mixin-deep](https://github.com/jonschlinkert/mixin-deep)
40-
- [mixin-object](https://github.com/jonschlinkert/mixin-object)
41-
- [object-length](https://github.com/jonschlinkert/object-length)
42-
- [omit-empty](https://github.com/jonschlinkert/omit-empty)
43-
- [reduce-object](https://github.com/jonschlinkert/reduce-object)
44-
45-
4624
## License
4725
{%= copyright() %}
4826
{%= license() %}

README.md

Lines changed: 38 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,37 @@
1-
# 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)
1+
# 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

33
> 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
5-
Why another array `difference` lib? I wanted the [fastest, correct implementation](./benchmark) I could find.
5+
## Install
66

7-
## Install with [npm](npmjs.org)
7+
Install with [npm](https://www.npmjs.com/)
88

9-
```bash
10-
npm i arr-diff --save
9+
```sh
10+
$ npm i arr-diff --save
1111
```
12-
### Install with [bower](https://github.com/bower/bower)
1312

14-
```bash
15-
bower install arr-diff --save
13+
Install with [bower](http://bower.io/)
14+
15+
```sh
16+
$ bower install arr-diff --save
1617
```
1718

18-
## Usage
19+
## API
1920

20-
### [diff](index.js#L38)
21+
### [diff](index.js#L33)
2122

2223
Return the difference between the first array and additional arrays.
2324

24-
* `a` **{Array}**
25-
* `b` **{Array}**
26-
* `returns`: {Array}
25+
**Params**
26+
27+
* `a` **{Array}**
28+
* `b` **{Array}**
29+
* `returns` **{Array}**
30+
31+
**Example**
2732

2833
```js
29-
var diff = require('{%= name %}');
34+
var diff = require('arr-diff');
3035

3136
var a = ['a', 'b', 'c', 'd'];
3237
var b = ['b', 'c'];
@@ -35,47 +40,36 @@ console.log(diff(a, b))
3540
//=> ['a', 'd']
3641
```
3742

43+
## Related projects
3844

45+
* [arr-flatten](https://www.npmjs.com/package/arr-flatten): Recursively flatten an array or arrays. This is the fastest implementation of array flatten. | [homepage](https://github.com/jonschlinkert/arr-flatten)
46+
* [array-filter](https://www.npmjs.com/package/array-filter): Array#filter for older browsers. | [homepage](https://github.com/juliangruber/array-filter)
47+
* [array-intersection](https://www.npmjs.com/package/array-intersection): Return an array with the unique values present in _all_ given arrays using strict equality… [more](https://www.npmjs.com/package/array-intersection) | [homepage](https://github.com/jonschlinkert/array-intersection)
3948

40-
## Run tests
49+
## Running tests
4150

42-
```bash
43-
npm test
44-
```
51+
Install dev dependencies:
4552

46-
## Author
47-
48-
**Jon Schlinkert**
49-
50-
+ [github/jonschlinkert](https://github.com/jonschlinkert)
51-
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
53+
```sh
54+
$ npm i -d && npm test
55+
```
5256

57+
## Contributing
5358

54-
### Other javascript/node.js utils
59+
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/arr-diff/issues/new).
5560

56-
Other projects that I maintain:
61+
## Author
5762

58-
- [arr-flatten](https://github.com/jonschlinkert/arr-flatten)
59-
- [arrayify-compact](https://github.com/jonschlinkert/arrayify-compact)
60-
- [compact-object](https://github.com/jonschlinkert/compact-object)
61-
- [delete](https://github.com/jonschlinkert/delete)
62-
- [for-in](https://github.com/jonschlinkert/for-in)
63-
- [for-own](https://github.com/jonschlinkert/for-own)
64-
- [has-any](https://github.com/jonschlinkert/has-any)
65-
- [has-value](https://github.com/jonschlinkert/has-value)
66-
- [is-number](https://github.com/jonschlinkert/is-number)
67-
- [is-plain-object](https://github.com/jonschlinkert/is-plain-object)
68-
- [mixin-deep](https://github.com/jonschlinkert/mixin-deep)
69-
- [mixin-object](https://github.com/jonschlinkert/mixin-object)
70-
- [object-length](https://github.com/jonschlinkert/object-length)
71-
- [omit-empty](https://github.com/jonschlinkert/omit-empty)
72-
- [reduce-object](https://github.com/jonschlinkert/reduce-object)
63+
**Jon Schlinkert**
7364

65+
+ [github/jonschlinkert](https://github.com/jonschlinkert)
66+
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
7467

7568
## License
76-
Copyright (c) 2014 Jon Schlinkert
77-
Released under the MIT license
69+
70+
Copyright © 2015 Jon Schlinkert
71+
Released under the MIT license.
7872

7973
***
8074

81-
_This file was generated by [verb](https://github.com/assemble/verb) on December 28, 2014._
75+
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on August 23, 2015._

0 commit comments

Comments
 (0)