array-prototype-functions - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

 {
   "name": "array-prototype-functions",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Array prototype augmentation for easier arithmetics",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -9,2 +9,18 @@ # Array prototype functions
 
+## Usage
+
+The usage is dead simple. Just import the package and you're done:
+
+```
+// ES6 module
+import 'array-prototype-functions'
+
+// node.js
+require('array-prototype-functions')
+```
+
+Once the file is executed the `Array.prototype` is automatically augmented.
+
+Please note that if the functions are already present they will not be overriden! This means that if at any point in time the `Array.prototype` will gain functions like `head`, `tail` or any other that is provided by this library they will take precedense over the ones from this library.
+
 ## Why augmenting the `Array.prototype`?
@@ -11,0 +27,0 @@

No alert changes

Improved metrics

Total package byte prevSize

13806

increased by4.16%

Number of lines in readme file

132

increased by13.79%

No dependency changes