25 lines
No EOL
1.1 KiB
Markdown
25 lines
No EOL
1.1 KiB
Markdown
# gorealis [](https://godoc.org/github.com/rdelval/gorealis)
|
|
|
|
Go library for communicating with [Apache Aurora](https://github.com/apache/aurora).
|
|
Named after the northern lights (Aurora Borealis).
|
|
|
|
### Aurora version compatibility
|
|
Please see [.auroraversion](./.auroraversion) to see the latest Aurora version against which this
|
|
library has been tested. Vendoring a working version of this library is highly recommended.
|
|
|
|
## 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
|
|
* End to end testing with Vagrant setup
|
|
|
|
## Importing
|
|
* 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`
|
|
|
|
## Contributions
|
|
Contributions are very much welcome. Please raise an issue so that the contribution may be discussed before it's made. |