Adding basic readme.

This commit is contained in:
Renan DelValle 2017-12-03 12:49:06 -08:00
parent 8e0988513a
commit d9810a8279

29
README.md Normal file
View file

@ -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.