diff --git a/README.md b/README.md index 9d5257c..a0ce45a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ # Dual +Dual is a simple management tool that allows you to create custom hostnames for dynamic IP address locally. + +## Running Dual + +Make sure your configuration file [cfg/gen.cfg](cfg/gen.cfg) is correct before running this program. + +```sh +$ java -jar Dual.jar +``` + +## Building Dual + +```sh +$ make +``` +