diff --git a/README.md b/README.md index bbe61d6..36a30cb 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,15 @@ -# Ungleich dns cli tool +# ungleich cli -A python package to set reverse dns in ungleich vm. +This CLI is used for day-to-day tasks used at ungleich. +It is intended to be used by ungleich engineers and skilled customers. -## Requirements +## Requirements / Installation -You need at least python 3. +* ensure you have python3 +* git clone this repo +* python ungleich-cli.py -## Usage +## Usage: DNS installing the package via pip (python3 required)