diff --git a/README.md b/README.md index e939328..b794c5c 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,18 @@ This is a Python script that adds and removes entries to your `hosts` file. It w I was tired of manually adding entries and never cleaning them up, so I created `hosts.py` to help manage that for me. +## Usage +``` +hosts.py [parameters] + +Commands: +add - Add an IP and corrosponding hostname to the hosts file +del - Deletes the specified IP or hostname from the hosts file +clear - Clears out all ips/hostnames that were added by this utility + +Examples: +hosts.py add 10.10.10.10 myhost.local +hosts.py del 10.10.10.10 +hosts.py del myhost.local +hosts.py clear +```