Improve readme

readme.md

@@ -6,17 +6,18 @@
 
 Inform users of your package of updates in a non-intrusive way.
 
-#### Table of Contents
+#### Contents
 
 - [Examples](#examples)
 - [How](#how)
 - [API](#api)
 - [About](#about)
+- [Users](#users)
 
 
 ## Examples
 
-### Simple example
+### Simple
 
 ```js
 const updateNotifier = require('update-notifier');
@@ -25,7 +26,7 @@ const pkg = require('./package.json');
 updateNotifier({pkg}).notify();
 ```
 
-### Comprehensive example
+### Comprehensive
 
 ```js
 const updateNotifier = require('update-notifier');
@@ -43,41 +44,45 @@ console.log(notifier.update);
 {
 	latest: '1.0.1',
 	current: '1.0.0',
-	type: 'patch', // possible values: latest, major, minor, patch, prerelease, build
+	type: 'patch', // Possible values: latest, major, minor, patch, prerelease, build
 	name: 'pageres'
 }
 */
 ```
 
-### Example with settings and custom message
+### Options and custom message
 
 ```js
 const notifier = updateNotifier({
 	pkg,
 	updateCheckInterval: 1000 * 60 * 60 * 24 * 7 // 1 week
 });
 
-console.log(`Update available: ${notifier.update.latest}`);
+if (notifier.update) {
+	console.log(`Update available: ${notifier.update.latest}`);
+}
 ```
 
 
 ## How
 
-Whenever you initiate the update notifier and it's not within the interval threshold, it will asynchronously check with npm in the background for available updates, then persist the result. The next time the notifier is initiated the result will be loaded into the `.update` property. This prevents any impact on your package startup performance.
-The check process is done in a unref'ed [child process](http://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options). This means that if you call `process.exit`, the check will still be performed in its own process.
+Whenever you initiate the update notifier and it's not within the interval threshold, it will asynchronously check with npm in the background for available updates, then persist the result. The next time the notifier is initiated, the result will be loaded into the `.update` property. This prevents any impact on your package startup performance.
+The update check is done in a unref'ed [child process](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options). This means that if you call `process.exit`, the check will still be performed in its own process.
+
+The first time the user runs your app, it will check for an update, and even if an update is available, it will wait the specified `updateCheckInterval` before notifying the user. This is done to not be annoying to the user, but might surprise you as an implementer if you're testing whether it works. Check out [`example.js`](example.js) to quickly test out `update-notifier` and see how you can test that it works in your app.
 
 
 ## API
 
-### updateNotifier(options)
+### notifier = updateNotifier(options)
 
-Checks if there is an available update. Accepts settings defined below. Returns an object with update info if there is an available update, otherwise `undefined`.
+Checks if there is an available update. Accepts options defined below. Returns an instance with an `.update` property there is an available update, otherwise `undefined`.
 
 ### options
 
 #### pkg
 
-Type: `object`
+Type: `Object`
 
 ##### name
 
@@ -92,49 +97,50 @@ Type: `string`
 #### updateCheckInterval
 
 Type: `number`<br>
-Default: 1000 * 60 * 60 * 24 (1 day)
+Default: `1000 * 60 * 60 * 24` *(1 day)*
 
 How often to check for updates.
 
 #### callback(error, update)
 
-Type: `function`<br>
+Type: `Function`
 
-Passing a callback here will make it check for an update directly and report right away. Not recommended as you won't get the benefits explained in [`How`](#how).
+Passing a callback here will make it check for an update directly and report right away. Not recommended as you won't get the benefits explained in [`How`](#how). `update` is equal to `notifier.update`.
 
-`update` is equal to `notifier.update`
+### notifier.notify([options])
 
+Convenience method to display a notification message. *(See screenshot)*
 
-### updateNotifier.notify([options])
+Only notifies if there is an update and the process is [TTY](https://nodejs.org/api/process.html#process_tty_terminals_and_process_stdout).
 
-Convenience method to display a notification message *(see screenshot)*.
+#### options
 
-Only notifies if there is an update and the process is [TTY](http://nodejs.org/api/tty.html).
+Type: `Object`
 
-#### options.defer
+##### defer
 
 Type: `boolean`<br>
 Default: `true`
 
 Defer showing the notification to after the process has exited.
 
-#### options.message
+##### message
 
 Type: `string`<br>
-Default: [See the screen shot above](https://github.com/yeoman/update-notifier#update-notifier-)
+Default: [See above screenshot](https://github.com/yeoman/update-notifier#update-notifier-)
 
-The message that will be shown when an update is available.
+Message that will be shown when an update is available.
 
-#### options.boxenOpts
+##### boxenOpts
 
-Type: `object`<br>
-Default: `{ padding: 1, margin: 1, align: 'center', borderColor: 'yellow', borderStyle: 'round' }` ([See the screen shot above](https://github.com/yeoman/update-notifier#update-notifier-))
+Type: `Object`<br>
+Default: `{padding: 1, margin: 1, align: 'center', borderColor: 'yellow', borderStyle: 'round'}` *(See screenshot)*
 
-The object that will be passed to [boxen](https://github.com/sindresorhus/boxen).
+Options object that will be passed to [`boxen`](https://github.com/sindresorhus/boxen).
 
 ### User settings
 
-Users of your module have the ability to opt-out of the update notifier by changing the `optOut` property to `true` in `~/.config/configstore/update-notifier-[your-module-name].yml`. The path is available in `notifier.config.path`.
+Users of your module have the ability to opt-out of the update notifier by changing the `optOut` property to `true` in `~/.config/configstore/update-notifier-[your-module-name].json`. The path is available in `notifier.config.path`.
 
 Users can also opt-out by [setting the environment variable](https://github.com/sindresorhus/guides/blob/master/set-environment-variables.md) `NO_UPDATE_NOTIFIER` with any value or by using the `--no-update-notifier` flag on a per run basis.
 
@@ -143,18 +149,18 @@ Users can also opt-out by [setting the environment variable](https://github.com/
 
 The idea for this module came from the desire to apply the browser update strategy to CLI tools, where everyone is always on the latest version. We first tried automatic updating, which we discovered wasn't popular. This is the second iteration of that idea, but limited to just update notifications.
 
+
+## Users
+
 There are a bunch projects using it:
 
 - [Yeoman](http://yeoman.io) - Modern workflows for modern webapps
 - [AVA](https://ava.li) - Simple concurrent test runner
 - [XO](https://github.com/sindresorhus/xo) - JavaScript happiness style linter
 - [Pageres](https://github.com/sindresorhus/pageres) - Capture website screenshots
 - [Node GH](http://nodegh.io) - GitHub command line tool
-- [Bower](http://bower.io) - A package manager for the web
-- [Hoodie CLI](http://hood.ie) - Hoodie command line tool
-- [Roots](http://roots.cx) - A toolkit for advanced front-end development
 
-[And 600+ more...](https://www.npmjs.org/browse/depended/update-notifier)
+[And 1200+ more…](https://www.npmjs.org/browse/depended/update-notifier)
 
 
 ## License