Update examples

Author: axelrindle

docs/docs/examples/01-basic/async.md

@@ -3,7 +3,7 @@
 The future is now! Futuristic approach leveraging top-level await.
 
 ```js showLineNumbers title="src/util/version-check.js"
-const versionCheck = require('github-version-checker')
+const versionCheck = require('@github-version-checker/core')
 const options = {
     // token: '...',
     repo: 'github-version-checker',
@@ -13,7 +13,7 @@ const options = {
 
 try {
     // highlight-next-line
-    const update = await versionCheck(options)
+    const { 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.name)
         console.log('You are on version ' + options.currentVersion + '!')

docs/docs/examples/01-basic/callback.md

@@ -3,20 +3,21 @@
 Using a plain old callback.
 
 ````js showLineNumbers title="src/util/version-check.js"
-const versionCheck = require('github-version-checker')
+const versionCheck = require('@github-version-checker/core')
 const options = {
     // token: '...',
     repo: 'github-version-checker',
     owner: 'axelrindle',
     currentVersion: require('../package.json').version
 }
 
-versionCheck(options, function (error, update) {
+versionCheck(options, function (error, result) {
     if (error) {
         console.error(error)
         process.exit(-1)
     }
 
+    const { update } = result
     if (update) {
         console.log('An update is available! ' + update.name)
         console.log('You are on version ' + options.currentVersion + '!')

docs/docs/examples/01-basic/promise.md

@@ -3,7 +3,7 @@
 Modern version using a Promise-based approach.
 
 ```js showLineNumbers title="src/util/version-check.js"
-const versionCheck = require('github-version-checker')
+const versionCheck = require('@github-version-checker/core')
 const options = {
     // token: '...',
     repo: 'github-version-checker',
@@ -12,7 +12,8 @@ const options = {
 }
 
 versionCheck(options)
-    .then(function (update) {
+    .then(function (result) {
+        const { update } = result
         if (update) { // update is null if there is no update available, so check here
             console.log('An update is available! ' + update.name)
             console.log('You are on version ' + options.currentVersion + '!')

docs/docs/examples/02-advanced/git-tags.md

@@ -6,7 +6,7 @@ releases api won't work.
 Fetch the tags instead by setting `fetchTags` to `true`:
 
 ```js showLineNumbers title="src/util/version-check.js"
-const versionCheck = require('github-version-checker')
+const versionCheck = require('@github-version-checker/core')
 const options = {
     token: 'my-token',
     repo: 'github-version-checker',
@@ -16,12 +16,13 @@ const options = {
     fetchTags: true
 }
 
-versionCheck(options, function (error, update) {
+versionCheck(options, function (error, result) {
     if (error) {
         console.error(error)
         process.exit(-1)
     }
 
+    const { update } = result
     if (update) {
         console.log('An update is available! ' + update.name)
         console.log('You are on version ' + options.currentVersion + '!')

docs/docs/examples/02-advanced/rest.md

@@ -5,7 +5,7 @@ There may be scenarios where you explicitly want to call the REST API.
 Set the `token` to `false` to accomplish this:
 
 ```js showLineNumbers title="src/util/version-check.js"
-const versionCheck = require('github-version-checker')
+const versionCheck = require('@github-version-checker/core')
 const options = {
     // highlight-next-line
     token: false,
@@ -15,7 +15,8 @@ const options = {
 }
 
 versionCheck(options)
-    .then(function (update) {
+    .then(function (result) {
+        const { update } = result
         if (update) { // update is null if there is no update available, so check here
             console.log('An update is available! ' + update.name)
             console.log('You are on version ' + options.currentVersion + '!')