gorealis-v2/README.md

# gorealis [![GoDoc](https://godoc.org/github.com/paypal/gorealis?status.svg)](https://godoc.org/github.com/paypal/gorealis)

Go library for interacting with [Apache Aurora](https://github.com/apache/aurora).

### Aurora version compatibility
Please see [.auroraversion](./.auroraversion) to see the latest Aurora version against which this
library has been tested.

## Usage

* [Getting started](docs/getting-started.md)
* [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

## Contributions
Contributions are always welcome. Please raise an issue so that the contribution may be discussed before it's made.
out with the old (address) in with the new (address) 2017-10-12 17:07:43 -07:00			`# gorealis [![GoDoc](https://godoc.org/github.com/paypal/gorealis?status.svg)](https://godoc.org/github.com/paypal/gorealis)`
Public release of gorealis 2016-08-02 11:42:00 -07:00
Updating wording. Removed vendoring section and some superfluous info. 2017-03-23 19:08:15 -04:00			`Go library for interacting with [Apache Aurora](https://github.com/apache/aurora).`
Public release of gorealis 2016-08-02 11:42:00 -07:00
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:45:54 -07:00			`### Aurora version compatibility`
Rename AURORA.VER to .auroraversion to be mirror the way Aurora keeps track of version 2016-08-15 11:58:08 -07:00			`Please see [.auroraversion](./.auroraversion) to see the latest Aurora version against which this`
Updating wording. Removed vendoring section and some superfluous info. 2017-03-23 19:08:15 -04:00			`library has been tested.`
Fixed copy paste error on command. Added AURORA.VER to keep track of which Aurora version library has been tested with 2016-08-09 13:29:28 -07:00
Public release of gorealis 2016-08-02 11:42:00 -07:00			`## Usage`

Integrated information from using the sample client document and reframed the sample client document. Added a link from the README to the getting-started page. 2016-08-11 11:39:10 -07:00			`* [Getting started](docs/getting-started.md)`
Rearranging documentation to make it more easily digestible 2016-08-09 17:10:02 -07:00			`* [Using the sample client](docs/using-the-sample-client.md)`
			`* [Leveraging the library](docs/leveraging-the-library.md)`
Public release of gorealis 2016-08-02 11:42:00 -07:00
			`## To Do`
Integrated information from using the sample client document and reframed the sample client document. Added a link from the README to the getting-started page. 2016-08-11 11:39:10 -07:00			`* Create or import a custom transport that uses https://github.com/jmcvetta/napping to improve efficiency`
Public release of gorealis 2016-08-02 11:42:00 -07:00
			`## Contributions`
Updating wording. Removed vendoring section and some superfluous info. 2017-03-23 19:08:15 -04:00			`Contributions are always welcome. Please raise an issue so that the contribution may be discussed before it's made.`