Added some examples.

Author: Axel Rindle

examples/callback.js

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+'use strict'
+
+// register coffeescript
+require('coffeescript/register')
+
+const versionCheck = require('../lib/main')
+const options = {
+  repo: 'axelrindle/github-version-checker',
+  currentVersion: require('../package.json').version
+}
+
+versionCheck(options, function (update, error) {
+  if (error) {
+    console.error(error);
+    process.exit(-1)
+  }
+
+  if (update) {
+    console.log("An update is available! " + update.tag_name);
+    console.log("You are on version " + options.currentVersion + "!");
+  }
+})

examples/promise.js

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+'use strict'
+
+// register coffeescript
+require('coffeescript/register')
+
+const versionCheck = require('../lib/main')
+const options = {
+  repo: 'axelrindle/github-version-checker',
+  currentVersion: require('../package.json').version
+}
+
+versionCheck(options).then(function (update) {
+  if (update) { // update is null if there is no update available, so check here
+    console.log("An update is available! " + update.tag_name)
+    console.log("You are on version " + options.currentVersion + "!")
+  }
+}).catch(function (error) {
+  console.error(error)
+})

examples/promise_async.js

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+(async () => {
+
+  // register coffeescript
+  require('coffeescript/register')
+
+  const versionCheck = require('../lib/main')
+  const options = {
+    repo: 'axelrindle/github-version-checker',
+    currentVersion: require('../package.json').version
+  }
+
+  try {
+    update = await versionCheck(options)
+    if (update) { // update is null if there is no update available, so check here
+      console.log("An update is available! " + update.tag_name)
+      console.log("You are on version " + options.currentVersion + "!")
+    }
+  } catch (e) {
+    console.error(e);
+  }
+})()