diff --git a/README.md b/README.md index 966c92ae..29eeeebd 100644 --- a/README.md +++ b/README.md @@ -20,10 +20,12 @@ warns if there is a newer version of CLI released This plugin shows a warning message if a user is running an out of date CLI. -This checks the version against the npm registry asynchronously in a forked process, at most once per 24 hours. It then saves a version file to the cache directory that will enable the warning. The upside of this method is that it won't block a user while they're using your CLI—the downside is that it will only display _after_ running a command that fetches the new version. - ![screenshot](./assets/screenshot.png) +# How it works + +This checks the version against the npm registry asynchronously in a forked process, at most once per 24 hours. It then saves a version file to the cache directory that will enable the warning. The upside of this method is that it won't block a user while they're using your CLI—the downside is that it will only display _after_ running a command that fetches the new version. + # Installation Add the plugin to your project with `yarn add @oclif/plugin-warn-if-update-available`, then add it to the `package.json` of the oclif CLI: