ridv/gorealis-v2
1
0
Fork 0
Code Issues Pull requests Projects Releases 13 Packages Wiki Activity Actions

Updating wording. Removed vendoring section and some superfluous info.

Browse source
This commit is contained in:
Renan DelValle 2017-03-23 19:08:15 -04:00
parent 764cfac099
commit 8f505815d5
1 changed files with 3 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -1,11 +1,10 @@
# gorealis [![GoDoc](https://godoc.org/github.com/rdelval/gorealis?status.svg)](https://godoc.org/github.com/rdelval/gorealis) # 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](https://github.com/apache/aurora). Go library for interacting with [Apache Aurora](https://github.com/apache/aurora).
Named after the northern lights (Aurora Borealis).
### Aurora version compatibility ### Aurora version compatibility
Please see [.auroraversion](./.auroraversion) to see the latest Aurora version against which this 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. library has been tested.
## Usage ## Usage
@ -17,9 +16,5 @@ library has been tested. Vendoring a working version of this library is highly r
* Create or import a custom transport that uses https://github.com/jmcvetta/napping to improve efficiency * Create or import a custom transport that uses https://github.com/jmcvetta/napping to improve efficiency
* End to end testing with Vagrant setup * 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
Contributions are very much welcome. Please raise an issue so that the contribution may be discussed before it's made. Contributions are always welcome. Please raise an issue so that the contribution may be discussed before it's made.