Neat Paraskavedekatriaphobia's Meaning
    Wondering what’s next for npm?Check out our public roadmap! »

    check-update-github

    0.0.4 • Public • Published

    check-update-github

    Check if there are a update on github repository.

    Build Status NPM version

    npm install --save check-update-github

    Example

    var checkUpdate = require('check-update-github');
    var pkg = require('./package.json');
     
    checkUpdate({
        name: pkg.name, 
        currentVersion: pkg.version, 
        user: 'your-github-accound',
        branch: 'master'
        }, function(err, latestVersion, defaultMessage){
        if(!err){
            console.log(defaultMessage);
        }
    });

    Options

    name

    Required
    Type: string

    Define the package name for search in Github.

    currentVersion

    Required if you want a default message
    Type: string

    Define the version currently installed.

    user

    Required
    Type: string

    Define the github acount for search in Github.

    branch

    Type: string Default: master

    Define the git branch for search in Github.

    Install

    npm i check-update-github

    DownloadsWeekly Downloads

    223

    Version

    0.0.4

    License

    none

    Last publish

    Collaborators

    • avatar