@f/array-equal - npm Package Compare versions

Comparing version 1.1.1 to 1.2.0

package.json

 {
   "name": "@f/array-equal",
   "description": "Check if two arrays have shallow equality",
-  "repository": "git://github.com/micro-js/array-equal.git",
-  "version": "1.1.1",
+  "repository": "git://github.com/micro-js/equal-array.git",
+  "version": "1.2.0",
   "license": "MIT",
@@ -7,0 +7,0 @@ "main": "lib/index.js",

Readme.md

 
-# array-equal
+# equal-array
 
-[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)
+[![Build status][travis-image]][travis-url]
+[![Git tag][git-image]][git-url]
+[![NPM version][npm-image]][npm-url]
+[![Code style][standard-image]][standard-url]
 
@@ -10,21 +13,34 @@ Check if two arrays have shallow equality
 
-    $ npm install @f/array-equal
+    $ npm install @f/equal-array
 
 ## Usage
 
-`arrayEqual([1, 2], [1, 2]) === true`
+```js
+var equal = require('@f/equal-array')
 
-`arrayEqual([1, 2], [1, 2, 3]) === false`
+equal([1, 2], [1, 2]) // => true
+equal([1, 2], [1, 2, 3]) // => false
 
+```
 
-## License
+## API
 
-The MIT License
+### equal(arr1, arr2)
 
-Copyright © 2015, Weo.io <[e-mail]>
+- `arr1` - First array.
+- `arr2` - Second array.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+**Returns:** Boolean.
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+## License
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+MIT
+
+[travis-image]: https://img.shields.io/travis/micro-js/equal-array.svg?style=flat-square
+[travis-url]: https://travis-ci.org/micro-js/equal-array
+[git-image]: https://img.shields.io/github/tag/micro-js/equal-array.svg
+[git-url]: https://github.com/micro-js/equal-array
+[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
+[standard-url]: https://github.com/feross/standard
+[npm-image]: https://img.shields.io/npm/v/@f/equal-array.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/@f/equal-array

New alerts

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Fixed alerts

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

46

increased by53.33%

Worsened metrics

Total package byte prevSize

2381

decreased by-10.82%

No dependency changes