diff --git a/README.md b/README.md index d1c0fc4..ee895a4 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,7 @@ * [Foreword](#foreword) * [Install](#install) +* [Upgrading](#upgrading) * [Usage and Examples](#usage-and-examples) * [Instance Options](#instance-options) * [Job Options](#job-options) @@ -77,6 +78,11 @@ yarn add bree ``` +## Upgrading + +To see details about upgrading from the last major version, check out this [doc](./UPGRADING.md). + + ## Usage and Examples The example below assumes that you have a directory `jobs` in the root of the directory from which you run this example. For example, if the example below is at `/path/to/script.js`, then `/path/to/jobs/` must also exist as a directory. If you wish to disable this feature, then pass `root: false` as an option. diff --git a/UPGRADING.md b/UPGRADING.md new file mode 100644 index 0000000..fc07282 --- /dev/null +++ b/UPGRADING.md @@ -0,0 +1,10 @@ +# Upgrading + + +## Upgrading from 7.x to 8.0 + +* Some fields have been converted from Objects to Maps: + * `closeWorkerAfterMs` + * `workers` + * `timeouts` + * `intervals` diff --git a/config.js b/config.js index c0758a6..bb5c052 100644 --- a/config.js +++ b/config.js @@ -10,6 +10,10 @@ docute.init({ { title: 'The best job scheduler for Node.js and JavaScript', path: '/' + }, + { + title: 'Upgrading', + path: '/UPGRADING' } ] },