Skip to content

Commit 8e6e121

Browse files
jonschlinkertjonschlinkert
committed
update benchmarks, docs. run verb
1 parent 227629f commit 8e6e121

File tree

2 files changed

+66
-35
lines changed

2 files changed

+66
-35
lines changed

‎.verb.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ This library versus [array-differ][], on {%= date() %}:
2020

2121
```
2222
{%= docs("benchmark/last.md") %}
23-
```
23+
```

‎README.md‎

Lines changed: 65 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
1-
# arr-diff [![NPM version](https://img.shields.io/npm/v/arr-diff.svg?style=flat)](https://www.npmjs.com/package/arr-diff) [![NPM downloads](https://img.shields.io/npm/dm/arr-diff.svg?style=flat)](https://npmjs.org/package/arr-diff) [![Build Status](https://img.shields.io/travis/jonschlinkert/arr-diff.svg?style=flat)](https://travis-ci.org/jonschlinkert/arr-diff)
1+
# arr-diff [![NPM version](https://img.shields.io/npm/v/arr-diff.svg?style=flat)](https://www.npmjs.com/package/arr-diff) [![NPM monthly downloads](https://img.shields.io/npm/dm/arr-diff.svg?style=flat)](https://npmjs.org/package/arr-diff) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/arr-diff.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/arr-diff)
22

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.
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
## Install
66

77
Install with [npm](https://www.npmjs.com/):
88

99
```sh
10-
$ npm install arr-diff --save
10+
$ npm install --save arr-diff
1111
```
1212

13-
Install with [bower](http://bower.io/)
13+
Install with [yarn](https://yarnpkg.com):
14+
15+
```sh
16+
$ yarn add arr-diff
17+
```
18+
19+
Install with [bower](https://bower.io/)
1420

1521
```sh
1622
$ bower install arr-diff --save
@@ -32,68 +38,93 @@ console.log(diff(a, b))
3238

3339
## Benchmarks
3440

35-
This library versus [array-differ](https://github.com/sindresorhus/array-differ), on May 07, 2016:
41+
This library versus [array-differ](https://github.com/sindresorhus/array-differ), on April 14, 2017:
3642

3743
```
44+
Benchmarking: (4 of 4)
45+
· long-dupes
46+
· long
47+
· med
48+
· short
49+
50+
# benchmark/fixtures/long-dupes.js (100804 bytes)
51+
arr-diff-3.0.0 x 822 ops/sec ±0.67% (86 runs sampled)
52+
arr-diff-4.0.0 x 2,141 ops/sec ±0.42% (89 runs sampled)
53+
array-differ x 708 ops/sec ±0.70% (89 runs sampled)
54+
55+
fastest is arr-diff-4.0.0
56+
3857
# benchmark/fixtures/long.js (94529 bytes)
39-
current x 1,246 ops/sec ±0.98% (85 runs sampled)
40-
array-differ x 993 ops/sec ±1.35% (87 runs sampled)
58+
arr-diff-3.0.0 x 882 ops/sec ±0.60% (87 runs sampled)
59+
arr-diff-4.0.0 x 2,329 ops/sec ±0.97% (83 runs sampled)
60+
array-differ x 769 ops/sec ±0.61% (90 runs sampled)
61+
62+
fastest is arr-diff-4.0.0
4163
4264
# benchmark/fixtures/med.js (708 bytes)
43-
current x 583,612 ops/sec ±1.24% (87 runs sampled)
44-
array-differ x 464,480 ops/sec ±1.42% (85 runs sampled)
65+
arr-diff-3.0.0 x 856,150 ops/sec ±0.42% (89 runs sampled)
66+
arr-diff-4.0.0 x 4,665,249 ops/sec ±1.06% (89 runs sampled)
67+
array-differ x 653,888 ops/sec ±1.02% (86 runs sampled)
68+
69+
fastest is arr-diff-4.0.0
4570
4671
# benchmark/fixtures/short.js (60 bytes)
47-
current x 788,823 ops/sec ±0.95% (89 runs sampled)
48-
array-differ x 521,483 ops/sec ±1.65% (86 runs sampled)
72+
arr-diff-3.0.0 x 3,078,467 ops/sec ±0.77% (93 runs sampled)
73+
arr-diff-4.0.0 x 9,213,296 ops/sec ±0.65% (89 runs sampled)
74+
array-differ x 1,337,051 ops/sec ±0.91% (92 runs sampled)
75+
76+
fastest is arr-diff-4.0.0
4977
```
5078

51-
## Related projects
79+
## About
5280

53-
You might also be interested in these projects:
81+
### Related projects
5482

55-
* [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)
56-
* [array-filter](https://www.npmjs.com/package/array-filter): Array#filter for older browsers. | [homepage](https://github.com/juliangruber/array-filter)
57-
* [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)
83+
* [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 "Recursively flatten an array or arrays. This is the fastest implementation of array flatten.")
84+
* [array-filter](https://www.npmjs.com/package/array-filter): Array#filter for older browsers. | [homepage](https://github.com/juliangruber/array-filter "Array#filter for older browsers.")
85+
* [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://github.com/jonschlinkert/array-intersection) | [homepage](https://github.com/jonschlinkert/array-intersection "Return an array with the unique values present in _all_ given arrays using strict equality for comparisons.")
5886

59-
## Contributing
87+
### Contributing
6088

61-
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/arr-diff/issues/new).
89+
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
6290

63-
## Building docs
91+
### Contributors
6492

65-
Generate readme and API documentation with [verb](https://github.com/verbose/verb):
93+
| **Commits** | **Contributor** |
94+
| --- | --- |
95+
| 33 | [jonschlinkert](https://github.com/jonschlinkert) |
96+
| 2 | [paulmillr](https://github.com/paulmillr) |
6697

67-
```sh
68-
$ npm install verb && npm run docs
69-
```
98+
### Building docs
99+
100+
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
70101

71-
Or, if [verb](https://github.com/verbose/verb) is installed globally:
102+
To generate the readme, run the following command:
72103

73104
```sh
74-
$ verb
105+
$ npm install -g verbose/verb#dev verb-generate-readme && verb
75106
```
76107

77-
## Running tests
108+
### Running tests
78109

79-
Install dev dependencies:
110+
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
80111

81112
```sh
82-
$ npm install -d && npm test
113+
$ npm install && npm test
83114
```
84115

85-
## Author
116+
### Author
86117

87118
**Jon Schlinkert**
88119

89120
* [github/jonschlinkert](https://github.com/jonschlinkert)
90-
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
121+
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
91122

92-
## License
123+
### License
93124

94-
Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
95-
Released under the [MIT license](https://github.com/jonschlinkert/arr-diff/blob/master/LICENSE).
125+
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
126+
Released under the [MIT License](LICENSE).
96127

97128
***
98129

99-
_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on May 07, 2016._
130+
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.5.0, on April 14, 2017._

0 commit comments

Comments
 (0)