check-for-updates v1.0.5

check-for-updates

An NPM module to easily check a project's github page for new releases!

Installation

npm install check-for-updates

Usage

const {check, getLatest} = require('check-for-updates'); check-for-updates.check() returns a promise that resolves with a JS object containing two fields. isNew is a boolean that states whether the newest non-draft, non-prerelease version of the app is greater than the one listed in package.json. url is a String containing the URL of the latest release, regardless of the value of isNew getLatest() returns a promise that resolves with the version (such as v1.0.0) of the latest non-draft, non-prerelease release on Github

Contributing

Contributing is welcome