From d9810a8279d827487003bec24999d8da2813b86d Mon Sep 17 00:00:00 2001 From: Renan DelValle Date: Sun, 3 Dec 2017 12:49:06 -0800 Subject: [PATCH] Adding basic readme. --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..69b753e --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Australis + +A light-weight client for [Apache Aurora](https://aurora.apache.org/) built using [gorealis](https://github.com/paypal/gorealis). + +## Usage + +``` +Usage: + australis [command] + +Available Commands: + create Create an Aurora Job + help Help about any command + kill Kill an Aurora Job + start Start a service or maintenance on a host (DRAIN). + stop Stop a service or maintenance on a host (DRAIN). + +Flags: + -h, --help help for australis + -p, --password string Password to use for API authentification + -u, --username string Username to use for API authentification + -z, --zookeeper string Zookeeper node(s) where Aurora stores information. + +Use "australis [command] --help" for more information about a command. +``` + + +## Status +Australis is a work in progress and does not support all the features of Apache Aurora. \ No newline at end of file