1 files changed, 18 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..eaf4608
--- /dev/null
+++ b/README
@@ -0,0 +1,18 @@
+tools:
+
+ipgen: generates IPs based on IP and netmask.
+example: ipgen 192.168.0.4 255.255.255.252
+outputs:
+192.168.0.4
+192.168.0.5
+192.168.0.6
+192.168.0.7
+
+cidr: converts cidr notation to IP and netmask.
+example: cidr 192.168.0.4/30
+outputs:
+192.168.0.4 255.255.255.252
+
+these two programs were made to be used together like:
+
+ipgen $(cidr 192.168.0.4/30)