From b4d64b327f6192ed2ae85d9ad504f0af4be2e9ef Mon Sep 17 00:00:00 2001 From: Justin Riley Date: Fri, 7 Oct 2016 15:27:11 -0400 Subject: [PATCH] README: add usage --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 5d96bf7..8ec6a4e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,33 @@ # OneDNS Dyanmic DNS for OpenNebula + +## Usage +Global options: +``` +$ onedns --help +usage: onedns [-h] [--debug] [-d DOMAIN] [--one-address ONE_ADDRESS] + [--one-secret ONE_SECRET] [--one-proxy ONE_PROXY] + {daemon,shell} ... + +OneDNS - Dynamic DNS for OpenNebula + +positional arguments: + {daemon,shell} + +optional arguments: + -h, --help show this help message and exit + --debug ONE controller host address + -d DOMAIN, --domain DOMAIN + DNS domain to use + --one-address ONE_ADDRESS + ONE controller host address + --one-secret ONE_SECRET + ONE credentials to use (e.g. user:key) + --one-proxy ONE_PROXY + proxy host to use to connect to ONE controller +``` + +Run the `daemon` command to kick off onedns: +``` +$ onedns daemon --dns-port=53 +```