release

README

release

📦 go package to check for a new GitHub release

🚀 Install

Simply run the following in the root of your project directory:

go get -u github.com/Matt-Gleich/release

📄 Documentation

func Check

func Check(currentVersion string, repoURL string) (bool, string, error)

Check for an update. Takes in the current version and GitHub repo URL. Returns true or false if there is an update or not as well as the version value. Will return false if there is no network connection.

Example

package main

import "github.com/Matt-Gleich/release"

func main() {
    isOutdated, version, err := release.Check("v1.0.0", "https://github.com/Matt-Gleich/nuke/")
}

🙌 Contributing

Before contributing please read the CONTRIBUTING.md file

👥 Contributors

• @Matt-Gleich

Documentation

Index

• func Check(localVersion string, repoURL string) (bool, string, error)

Functions

func Check

func Check(localVersion string, repoURL string) (bool, string, error)

Check for an update. Takes in the current version and GitHub repo URL. Returns true or false if there is an update or not as well as the version value. Will return false if there is no network connection.