commit: 8e03ca2fb7cf9dc1c810e516c26eebe1592cd40e
parent: 9a9f9844ce4ed0eed3a8256570611f0e84609cc7
author: z0noxz <chris@noxz.tech>
date: Tue, 7 Aug 2018 14:08:22 +0200
update README.md
1 file changed, 18 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
@@ -1,4 +1,19 @@
-# ip2cidr
-Converts IPADDRESS to CIDR, or return CIDR if already a valid one
+ip2cidr
+======
+ip2cidr is a small and simple program for converting ip address (mask) into a
+CIDR, or returing an already valid one.
+
+Installation
+------------
+Edit config.mk to match your local setup (ip2cidr is installed into the
+/usr/local namespace by default), then simply enter the following command to
+install (if necessary as root):
+
+ make clean install
+
+Usage example of ip2cidr
+------------------------
+Allow user to enter a subnet mask as either a CIDR or as an ip address:
+
+ read -p "enter subnet mask: " output; output=$(ip2cidr "$output")
-install using `make clean install`.
