Skip to content

Commit

Permalink
Merge pull request #166 from vcapretz/release-v1
Browse files Browse the repository at this point in the history
release v1 and update docs
  • Loading branch information
vcapretz authored Nov 25, 2020
2 parents dd4e141 + 899e2d4 commit d4b39c9
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 10 deletions.
11 changes: 2 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,25 +17,18 @@ With this library you get a beautiful UI for visualizing what's happening with e

![UI](https://raw.githubusercontent.com/vcapretz/bull-board/master/shot.png)
![Fails](https://raw.githubusercontent.com/vcapretz/bull-board/master/fails.png)

## Notes

As this library provides only the visualization for your queues, keep in mind that:

- You must have Bull installed in your projects;
- You must have either [Bull](https://github.com/OptimalBits/bull) or [BullMQ](https://github.com/taskforcesh/bullmq) installed in your projects;
- Aside the options to retry and clean jobs, this library is not responsible for processing the jobs, reporting progress or any other thing. This must be done in your application with your own logic;
- If you want to understand the possibilities you have with the queues please refer to [Bull's docs](https://optimalbits.github.io/bull/);
- This library doesn't hijack Bull's way of working.

If you want to learn more about queues and Redis: https://redis.io/.

## Alpha Release v1.0.0

The code in the main branch is under alpha release, you can install it by using specific versions in your `package.json` file, otherwise you can checkout the branch `latest-stable` for our current stable release.

This README file is **not** matching the alpha version, we are changing APIs and we need to update the documentation.

For the brave and valuable souls help me trying to test the alpha, plese refer to [examples.js file](./example.js) to check how to implement it.

## Starting

To add it to your project start by adding the library to your dependencies list:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "bull-board",
"description": "Bull queue UI for inspecting jobs",
"version": "1.0.0-beta.1",
"version": "1.0.0",
"keywords": [
"bull",
"redis",
Expand Down

0 comments on commit d4b39c9

Please sign in to comment.