# github_release_check

[![CI](https://github.com/Celeo/github_release_check/workflows/CI/badge.svg?branch=master)](https://github.com/celeo/github_release_check/actions?query=workflow%3ACI)
[![Crates.io](https://img.shields.io/crates/v/github_release_check.svg)](https://crates.io/crates/github_release_check)
[![Docs.rs](https://docs.rs/github_release_check/badge.svg)](https://docs.rs/github_release_check)
[![License](https://img.shields.io/crates/l/github_release_check)](https://github.com/Celeo/github_release_check/blob/master/Cargo.toml#L10)

Check latest GitHub release version

## Installing

Add the latest version to your `Cargo.toml`.

## Using

See [the docs](https://docs.rs/github_release_check), but effectively:

```rust
use github_release_check::GitHub;

let github = GitHub::new().unwrap();
let versions = github.get_all_versions("celeo/github_release_check").unwrap();
```

## Developing

### Building

### Requirements

* Git
* A recent version of [Rust](https://www.rust-lang.org/tools/install)

### Steps

```sh
git clone https://github.com/Celeo/github_release_check
cd github_release_check
cargo test
```

## License

Licensed under either of

* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE))
* MIT license ([LICENSE-MIT](LICENSE-MIT))

## Contributing

Please feel free to contribute. Please open an issue first (or comment on an existing one) so that I know that you want to add/change something.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.