![CI](https://github.com/axelrindle/github-version-checker/workflows/CI/badge.svg)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/f82826738d2b43b1b8ba40dd780d1784)](https://www.codacy.com/gh/axelrindle/github-version-checker/dashboard?utm_source=github.com&utm_medium=referral&utm_content=axelrindle/github-version-checker&utm_campaign=Badge_Grade)
[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/f82826738d2b43b1b8ba40dd780d1784)](https://www.codacy.com/gh/axelrindle/github-version-checker/dashboard?utm_source=github.com&utm_medium=referral&utm_content=axelrindle/github-version-checker&utm_campaign=Badge_Coverage)

# github-version-checker
> Simple **version checker** working with **GitHub releases** and the **GitHub API**.

## Note on upgrading to **v2.0.0**
If you are upgrading from a version before **v2.0.0**, please read [**this guide**](MIGRATING-TO-2.0.0.md).

## Supported Node.js versions

`>= 10`

## Install
```bash
$ npm install github-version-checker
```

## Documentation
[Check the Wiki](https://github.com/axelrindle/github-version-checker/wiki)

## License
[MIT](LICENSE)
