gorealis/README.md
Renan DelValle 7aa6c07c66 Cleaned up the README and added new information to Getting_Started.
Made client point to new location of docker-compose-executor release
2016-08-10 11:46:08 -07:00

21 lines
913 B
Markdown

# gorealis [![GoDoc](https://godoc.org/github.com/rdelval/gorealis?status.svg)](https://godoc.org/github.com/rdelval/gorealis)
Go library for communicating with Apache Aurora.
Named after the northern lights (Aurora Borealis).
### Aurora version compatibility
Please see [AURORA.VER](./AURORA.VER) to see the latest Aurora version against which this
library has been tested. Vendoring a working version of this library is highly recommended.
## Usage
* [Using the sample client](docs/using-the-sample-client.md)
* [Leveraging the library](docs/leveraging-the-library.md)
## To Do
* Create or import a custom transport that uses https://github.com/jmcvetta/napping to improve efficiency
* Allow library to use ZK to find the master
* End to end testing with Vagrant setup
## Contributions
Contributions are very much welcome. Please raise an issue so that the contribution may be discussed before it's made.