Skip to content

Commit

Permalink
add alpha section to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vcapretz committed Aug 20, 2020
1 parent eec8ea1 commit 792ddd5
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ As this library provides only the visualization for your queues, keep in mind th

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

0 comments on commit 792ddd5

Please sign in to comment.