Shorten project name to version-checker

Author: axelrindle

README.md

@@ -4,6 +4,14 @@
 [![Codacy grade](https://img.shields.io/codacy/grade/f82826738d2b43b1b8ba40dd780d1784?logo=codacy)](https://www.codacy.com/gh/axelrindle/github-version-checker/dashboard?utm_source=github.com&utm_medium=referral&utm_content=axelrindle/github-version-checker&utm_campaign=Badge_Grade)
 [![Codacy coverage](https://img.shields.io/codacy/coverage/f82826738d2b43b1b8ba40dd780d1784?logo=codacy)](https://www.codacy.com/gh/axelrindle/github-version-checker/dashboard?utm_source=github.com&utm_medium=referral&utm_content=axelrindle/github-version-checker&utm_campaign=Badge_Coverage)
 
+---
+
+🚧 **Notice** 🚧
+
+*This project is being renamed to just **version-checker** as I plan to support other platforms than Github in the future.*
+
+---
+
 # github-version-checker
 
 > Simple **version checker** working with **GitHub releases** and the **GitHub API**.
@@ -25,12 +33,12 @@ I do not plan on making this an ESM only module in the near future.
 ## Install
 
 ```bash
-$ npm install github-version-checker
+$ npm install @version-checker/core
 ```
 
 ## Documentation
 
-[github-version-checker (axelrindle.github.io)](https://axelrindle.github.io/github-version-checker/)
+[version-checker (axelrindle.github.io)](https://axelrindle.github.io/github-version-checker/)
 
 ## License
 

docs/changelog/2/2.0.0.md

@@ -8,5 +8,5 @@
 
 ## Changed
 
-- The `options` object changed and requires using a [personal access token](https://blog.github.com/2013-05-16-personal-api-tokens/). See [here](https://github.com/axelrindle/github-version-checker#the-options-object).
-- The `callback` structure changed. I decided to apply a node convention called **Error-First** in which a callback function's first parameter is the `error`. See [here](https://github.com/axelrindle/github-version-checker#the-callback-function-optional).
+- The `options` object changed and requires using a [personal access token](https://blog.github.com/2013-05-16-personal-api-tokens/). See [here](https://github.com/axelrindle/version-checker#the-options-object).
+- The `callback` structure changed. I decided to apply a node convention called **Error-First** in which a callback function's first parameter is the `error`. See [here](https://github.com/axelrindle/version-checker#the-callback-function-optional).

docs/changelog/unreleased.md

@@ -26,6 +26,6 @@ sidebar_position: 1
 
 ## Other
 
-- Documentation an other stuff is now hosted at https://axelrindle.github.io/github-version-checker/
+- Documentation an other stuff is now hosted at https://axelrindle.github.io/version-checker/
 - Moved to TypeScript.
 - Using [Lerna](https://lerna.js.org/) for monorepo management.

docs/docs/api.md

@@ -7,10 +7,10 @@ sidebar_label: 🧩 API
 
 ```js
 // Require the module
-const versionCheck = require('@github-version-checker/core');
+const versionCheck = require('@version-checker/core');
 
 // Or import
-import versionCheck from '@github-version-checker/core'
+import versionCheck from '@version-checker/core'
 ```
 
 ## `function versionCheck(options, [callback])`

docs/docs/cli/01-installation.md

@@ -3,9 +3,9 @@
 ## npm
 
 ```shell
-npm install -g @github-version-checker/cli
+npm install -g @version-checker/cli
 ```
 
 ## Binary
 
-Download a binary version from the [releases page](https://github.com/axelrindle/github-version-checker/releases).
+Download a binary version from the [releases page](https://github.com/axelrindle/version-checker/releases).

docs/docs/cli/02-examples.md

@@ -3,9 +3,9 @@
 ## Basic
 
 ```shell
-$ github-version-checker \
+$ version-checker \
     --owner axelrindle \
-    --repository github-version-checker \
+    --repository version-checker \
     --current-version 2.2.0
 ```
 
@@ -17,9 +17,9 @@ You are on version 2.3.0!
 ## With json output
 
 ```shell
-$ github-version-checker --json \
+$ version-checker --json \
     --owner axelrindle \
-    --repository github-version-checker \
+    --repository version-checker \
     --current-version 2.2.0
 ```
 
@@ -34,7 +34,7 @@ $ github-version-checker --json \
     "isPrerelease": false,
     "isDraft": false,
     "publishedAt": "2022-03-18T15:22:03Z",
-    "url": "https://github.com/axelrindle/github-version-checker/releases/tag/2.3.0"
+    "url": "https://github.com/axelrindle/version-checker/releases/tag/2.3.0"
   }
 }
 ```

docs/docs/cli/index.md

@@ -7,7 +7,7 @@ plain-text and JSON-formatted output.
 
 ```
 
-  $ github-version-checker [options]
+  $ version-checker [options]
 
   Options
     -o, --owner              The repository owner. May be a username or organization name.

docs/docs/development.md

@@ -5,14 +5,14 @@ sidebar_label: 👨‍💻 Development & Contributing
 
 # Development & Contributing
 
-Be sure to read the [Code of Conduct](https://github.com/axelrindle/github-version-checker/blob/main/CODE_OF_CONDUCT.md)
+Be sure to read the [Code of Conduct](https://github.com/axelrindle/version-checker/blob/main/CODE_OF_CONDUCT.md)
 
 ## Setup
 
 First of all clone the git repository :)
 
 ```shell
-$ git clone https://github.com/axelrindle/github-version-checker.git
+$ git clone https://github.com/axelrindle/version-checker.git
 ```
 
 and then install the dependencies

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

@@ -3,10 +3,10 @@
 The future is now! Futuristic approach leveraging top-level await.
 
 ```js showLineNumbers title="src/util/version-check.js"
-const versionCheck = require('@github-version-checker/core')
+const versionCheck = require('@version-checker/core')
 const options = {
     // token: '...',
-    repo: 'github-version-checker',
+    repo: 'version-checker',
     owner: 'axelrindle',
     currentVersion: require('../package.json').version
 }

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

@@ -3,10 +3,10 @@
 Using a plain old callback.
 
 ````js showLineNumbers title="src/util/version-check.js"
-const versionCheck = require('@github-version-checker/core')
+const versionCheck = require('@version-checker/core')
 const options = {
     // token: '...',
-    repo: 'github-version-checker',
+    repo: 'version-checker',
     owner: 'axelrindle',
     currentVersion: require('../package.json').version
 }