Browse Source

docs(job-queue-plugin): Add note on bullmq version

Relates to #1936
Michael Bromley 3 years ago
parent
commit
8fee246fa1
1 changed files with 4 additions and 2 deletions
  1. 4 2
      packages/job-queue-plugin/src/bullmq/plugin.ts

+ 4 - 2
packages/job-queue-plugin/src/bullmq/plugin.ts

@@ -28,11 +28,13 @@ import { BullMQPluginOptions } from './types';
  *
  * ## Installation
  *
- * `yarn add \@vendure/job-queue-plugin bullmq`
+ * `yarn add \@vendure/job-queue-plugin bullmq@1`
  *
  * or
  *
- * `npm install \@vendure/job-queue-plugin bullmq`
+ * `npm install \@vendure/job-queue-plugin bullmq@1`
+ *
+ * **Note:** The v1.x version of this plugin is designed to work with bullmq v1.x.
  *
  * @example
  * ```ts