ipterate - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "ipterate",
-  "version": "1.0.0",
-  "description": " A small utility library to allow you to iterate through all IPs within a given subnet. Remain efficient no matter how many IPs there are in the range.",
+  "version": "1.0.1",
+  "description": " A small utility library to allow you to iterate through all IPs within a given subnet. Remains efficient no matter how many IPs there are in the range.",
   "main": "index.js",
@@ -6,0 +6,0 @@ "scripts": {

README.md

@@ -7,6 +7,31 @@ # About
 
+For instance the following code
+
     const ipterate = require('ipterate');
+        
+    ipterate.range('10.0.1.0/29').iterate(ip => {
+        console.log(`IP: ${ip}`);
+    });
     
+prints out
+
+    10.0.1.0
+    10.0.1.1
+    10.0.1.2
+    10.0.1.3
+    10.0.1.4
+    10.0.1.5
+    10.0.1.6
+    10.0.1.7
+    
+and this one will traverse all IPs in existence:
+
+    const ipterate = require('ipterate');
+    
     ipterate.range('0.0.0.0/0').iterate(ip => {
         console.log(`IP: ${ip}`);
-    });
+    });
+    
+# Installation
+
+npm install --save ipterate

No alert changes

Improved metrics

Total package byte prevSize

7869

increased by5.74%

Number of lines in readme file

36

increased by227.27%

No dependency changes