Release v1.1.6

pouc · Jan 30, 2017 · 4129ef2 · 4129ef2
1 parent f76577c
commit 4129ef2
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -6,4 +6,4 @@
 **Author:** Lo&iuml;c Formont  
 **License**: MIT Licensed  
 **Example**  
-```javascriptvar equal = require("arr-equal");```
+```javascriptvar equal = require("arr-equal");equal([1, 2, 3], [1, 2, 3]) ==> trueequal([1, 2, 3], [1, 3, 2]) ==> falseequal([1, 2, 3], [1, 3, 2], {order: false}) ==> trueequal([1, [2, 3]], [1, [2, 3]]) ==> falseequal([1, [2, 3]], [1, [2, 3]], {deep: true}) ==> true```

diff --git a/index.js b/index.js
@@ -26,6 +26,14 @@ const undef = require('ifnotundef');
  * @example
  * ```javascript
  * var equal = require("arr-equal");
+ *
+ * equal([1, 2, 3], [1, 2, 3]) ==> true
+ *
+ * equal([1, 2, 3], [1, 3, 2]) ==> false
+ * equal([1, 2, 3], [1, 3, 2], {order: false}) ==> true
+ *
+ * equal([1, [2, 3]], [1, [2, 3]]) ==> false
+ * equal([1, [2, 3]], [1, [2, 3]], {deep: true}) ==> true
  * ```
  */
 module.exports = function(arr1, arr2, options) {

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "arr-equal",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "description": "check if two arrays are equal with options (order? shallow? ...)",
   "main": "index.js",
   "scripts": {