Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance Readme: Prioritize Yarn & Include pnpm, npm, bun Installation Options #2451

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Enhance Readme: Prioritize Yarn & Include pnpm, npm, bun Installation Options #2451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ad816aa
Expanded installation options to include pnpm, npm, and bun
ekamahuja Feb 25, 2024
edba769
Expanded installation options to include pnpm and bun" to reflect the…
ekamahuja Feb 25, 2024
1e11e0c
Reordered installation instructions, prioritizing yarn
ekamahuja Feb 25, 2024
f7bf232
Merge branch 'master' into installation-readme-update
ekamahuja Feb 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,9 @@ Install:

```
$ yarn add bullmq
$ npm install bullmq
$ pnpm add bullmq
$ bun add bullmq
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although I am quite confident that BullMQ works well with bun, I think we should warn that the test suite has still not been run against bun.

```

Add jobs to the queue:
Expand Down
19 changes: 19 additions & 0 deletions docs/gitbook/bull/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,25 @@ or Yarn:
yarn add bull
```

or Npm

```bash
npm install bull
```

or Pnpm:

```bash
pnpm add bull
```

or Bun:
```bash
bun add bull
```



In order to work with Bull, you also need to have a Redis server running. For local development you can easily install it using [docker](https://hub.docker.com/\_/redis/).

Bull will by default try to connect to a Redis server running on `localhost:6379`
Expand Down