Version 2.0.0 🎉

Author: Axel Rindle

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Axel Rindle
+Copyright (c) 2018 Axel Rindle
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

MIGRATING-TO-2.0.0.md

@@ -0,0 +1,8 @@
+# Migrating to Version `2.0.0`
+
+Please note the following changes, when you migrate from a version below `2.0.0`:
+
+- The `options` object changed and require 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).
+
+Before opening an issue, please confirm that you changed your code according to these changes.

README.md

@@ -1,14 +1,13 @@
 # github-version-checker
-Simple **version checker** working with **GitHub releases** and the **GitHub API**.
+> Simple **version checker** working with **GitHub releases** and the **GitHub API**.
+
+# Note on upgrading to **v2.0.0**
+If you are upgrading from a version before **v2.0.0**, please read [**this guide**](MIGRATING-TO-2.0.0.md).
 
 ## Install
 ```bash
 $ npm install github-version-checker
 ```
-or
-```bash
-$ yarn add github-version-checker
-```
 
 ## Usage
 ```javascript
@@ -18,16 +17,16 @@ const pkg = require('./package.json'); // or whereever your package.json lies
 
 // version check options (for details see below)
 const options = {
-  repo: 'axelrindle/github-version-checker', // will be expanded to https://api.github.com/repos/axelrindle/github-version-checker/releases
-  currentVersion: pkg.version, // your app's current version
-  includePreReleases: false // if you want to check pre-releases to
+  token: 'PUT-YOUR-TOKEN-HERE',                      // personal access token
+  repo: 'github-version-checker',                    // repository name
+  owner: 'axelrindle',                               // repository owner
+  currentVersion: pkg.version,                       // your app's current version
+  fetchTags: false                                   // whether to fetch releases or tags
 };
-versionCheck(options, function (update, error) { // callback function
+versionCheck(options, function (error, update) { // callback function
   if (error) throw error;
   if (update) { // print some update info if an update is available
-    console.log('An update is available!');
-    console.log('New version: ' + update.tag_name);
-    console.log('Details here: ' + update.html_url);
+    console.log('An update is available! ' + update.name);
   }
 
   // start your app
@@ -45,27 +44,51 @@ Always try to follow a clear [semver format](http://semver.org/). This helps to
 Performs an update check with the given options. The `callback` is optional, can be left out to return a `Promise`.
 
 #### The `options` object
-Option | Default value | Description
+Option | Description | Default Value
 --- | --- | ---
-repo | **None. Required option** | Defines from which GitHub repository to load releases from.
-currentVersion | **None. Required option** | Your app's current version. Needed to check if a newer release is found.
-includePreReleases | false | Whether or not to include pre-releases. **Note:** This will fetch **all** releases, which might result in high traffic, depending on how much releases your app has on GitHub.
+token |  A [personal access token](https://blog.github.com/2013-05-16-personal-api-tokens/) used to access the Github GraphQL API (as of version **2.0.0**).
+repo | The name of your Github repository.
+owner | The owner of your Github repository (usually your username).
+currentVersion | Your app's current version. Needed to check if a newer release is found.
+fetchTags | Whether to fetch the repositorie's git tags instead of the GitHub releases (this is useful when the releases are autogenerated from the tags). | `false`
 
 #### The `callback` function (optional)
 Should be of the following form:
 ```javascript
-function(update, error) {
+function(error, update) {
   // ...your code
 }
 ```
-* `update`:
-  * An object in the format specified [here](https://developer.github.com/v3/repos/releases/#get-a-single-release). `null` if no update was found.
 * `error`:
   * If an error occurs, this holds the error message. `null` if no error occurs.
+* `update`:
+  * An object in the format specified below. `null` if no update was found.
 
+#### Using `Promise`
+You can omit the `callback` function to return a `Promise`, which resolved with the `update` object.
 
-## Todo
+### Object schemes
+#### Releases
+When fetching releases, an object with the following structure will be returned:
+```js
+Object {
+  name
+  tag {
+    name
+  }
+  isPrerelease
+  publishedAt
+  url
+}
+```
+
+#### Tags
+When fetching tags, you will receive an object with the following structure:
+```js
+Object {
+  name
+}
+```
 
-* ~~Add a sync method returning just `true` or `false`~~ Can be achieved with **async/await**
-* ~~Add settings to define an own update service~~ For now, I stay with GitHub releases only
-* ~~Only compare to the latest release on GitHub (see [#1](https://github.com/axelrindle/github-version-checker/issues/1))~~
+## License
+[MIT](LICENSE)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "github-version-checker",
-  "version": "1.2.0",
+  "version": "2.0.0",
   "description": "Version checker working with GitHub releases.",
   "main": "index.js",
   "scripts": {