2016-08-09 16:18:30 -07:00
|
|
|
# gorealis [](https://godoc.org/github.com/rdelval/gorealis)
|
2016-08-02 11:42:00 -07:00
|
|
|
|
2016-08-24 17:28:40 -07:00
|
|
|
Go library for communicating with [Apache Aurora](https://github.com/apache/aurora).
|
2016-08-02 11:42:00 -07:00
|
|
|
Named after the northern lights (Aurora Borealis).
|
|
|
|
|
|
2016-08-10 11:45:54 -07:00
|
|
|
### Aurora version compatibility
|
2016-08-15 11:58:08 -07:00
|
|
|
Please see [.auroraversion](./.auroraversion) to see the latest Aurora version against which this
|
2016-08-09 17:10:02 -07:00
|
|
|
library has been tested. Vendoring a working version of this library is highly recommended.
|
2016-08-09 13:29:28 -07:00
|
|
|
|
2016-08-02 11:42:00 -07:00
|
|
|
## Usage
|
|
|
|
|
|
2016-08-11 11:39:10 -07:00
|
|
|
* [Getting started](docs/getting-started.md)
|
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)
|
2016-08-02 11:42:00 -07:00
|
|
|
|
|
|
|
|
## To Do
|
2016-08-11 11:39:10 -07:00
|
|
|
* Create or import a custom transport that uses https://github.com/jmcvetta/napping to improve efficiency
|
2016-08-09 16:25:07 -07:00
|
|
|
* End to end testing with Vagrant setup
|
2016-08-02 11:42:00 -07:00
|
|
|
|
2016-09-30 01:24:49 -04:00
|
|
|
## Importing
|
2016-11-02 19:54:44 -04:00
|
|
|
* We suggest using a vendoring tool such as [govendor](https://github.com/kardianos/govendor) and
|
|
|
|
|
fetching by version, for example: `govendor fetch github.com/rdelval/gorealis@v1`
|
2016-09-30 01:24:49 -04:00
|
|
|
|
2016-08-02 11:42:00 -07:00
|
|
|
## Contributions
|
2016-08-16 18:40:02 -07:00
|
|
|
Contributions are very much welcome. Please raise an issue so that the contribution may be discussed before it's made.
|
