# gorealis [![GoDoc](https://godoc.org/github.com/paypal/gorealis?status.svg)](https://godoc.org/github.com/paypal/gorealis) ![CI Build Status](https://github.com/paypal/gorealis/actions/workflows/main.yml/badge.svg) [![codecov](https://codecov.io/gh/paypal/gorealis/branch/main/graph/badge.svg)](https://codecov.io/gh/paypal/gorealis)

Version 1 of Go library for interacting with [Aurora Scheduler](https://github.com/aurora-scheduler/aurora).

Version 2 of this library can be found [here](https://github.com/aurora-scheduler/gorealis).

### 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)

## Projects using gorealis

* [australis](https://github.com/aurora-scheduler/australis)

## Contributions
Contributions are always welcome. Please raise an issue to discuss a contribution before it is made.