Initial readmeHEADmaster

1 files changed, 31 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a6d547b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+## Description
+
+Netexpand will list every ip address in a given range, including broadcast and
+network addresses.
+
+An example usage for this program might be to use it to calculate every rule in
+a firewall that uses slash notation for subnets (for an audit perhaps).
+
+
+## Example
+
+A simple example of calculating every ip address in the 127.0.0.1/16 range.
+
+    $ netexpand 127.0.0.1/16
+    127.0.0.1
+    127.0.0.2
+    127.0.0.3
+    127.0.0.4
+    127.0.0.5
+    127.0.0.6
+    127.0.0.7
+    ...
+
+
+Another slightly more complex example of using a bash for loop to feed ipv4
+networks to netexpand for creating a complete list of all ips with rules in a
+firewall.
+
+    for i in $(cat fwnets.txt); do
+      netexpand ${i}
+    done