Add readme to all packages

felixmosh · May 30, 2021 · 9e98bc5 · 9e98bc5
1 parent cba3e3e
commit 9e98bc5
Show file tree

Hide file tree

Showing 7 changed files with 120 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -10,9 +10,7 @@ With this library you get a beautiful UI for visualizing what's happening with e
   <a href="https://github.com/vcapretz/bull-board/blob/master/LICENSE">
     <img alt="licence" src="https://img.shields.io/github/license/vcapretz/bull-board">
   </a>
-  <a href="https://snyk.io/test/github/vcapretz/bull-board">
-    <img alt="snyk" src="https://snyk.io/test/github/vcapretz/bull-board/badge.svg">
-  </a>
+  <img alt="open issues" src="https://img.shields.io/github/issues/felixmosh/bull-board"/>
 <p>
 
 ![UI](https://raw.githubusercontent.com/felixmosh/bull-board/master/screenshots/shot.png)
@@ -24,14 +22,14 @@ As this library provides only the visualization for your queues, keep in mind th
 
 - 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/);
+- If you want to understand the possibilities you have with the queues please refer to [Bull's docs](https://optimalbits.github.io/bull/) or [BullMQ's docs](https://docs.bullmq.io/);
 - This library doesn't hijack Bull's way of working.
 
-If you want to learn more about queues and Redis: https://redis.io/.
+If you want to learn more about queues ([Bull](https://github.com/OptimalBits/bull) or [BullMQ](https://github.com/taskforcesh/bullmq)) and [Redis](https://redis.io/).
 
 ## Starting
 
-To add it to your project start by adding the library to your dependencies list:
+To add it to your project start by installing a server framework specific adapter to your dependencies list:
 
 ```sh
 yarn add @bull-board/express
@@ -40,9 +38,7 @@ yarn add @bull-board/fastify
 # or
 yarn add @bull-board/hapi
 ```
-
 Or
-
 ```sh
 npm i @bull-board/express
 # or
@@ -53,8 +49,6 @@ npm i @bull-board/hapi
 
 ## Hello World
 
-The first step is to setup `bull-board` by calling `createBullBoard` method.
-
 ```js
 const express = require('express')
 const Queue = require('bull')
@@ -91,7 +85,7 @@ That's it! Now you can access the `/admin/queues` route, and you will be able to
 
 
 For more advanced usages check the `examples` folder, currently it contains:
-1. [Basic authentication example](https://github.com/felixmosh/bull-board/tree/master/examples/with-auth)
+1. [Basic authentication example](https://github.com/felixmosh/bull-board/tree/master/examples/with-express-auth)
 2. [Multiple instance of the board](https://github.com/felixmosh/bull-board/tree/master/examples/with-multiple-instances)
 2. [With Fastify server](https://github.com/felixmosh/bull-board/tree/master/examples/with-fastify)
 2. [With Hapi.js server](https://github.com/felixmosh/bull-board/tree/master/examples/with-hapi)
@@ -160,7 +154,7 @@ Here are some tips:
 
 - Check the [issues page](https://github.com/felixmosh/bull-board/issues) for already opened issues (or maybe even closed ones) that might already address your question/bug/feature request.
 - When opening a bug report provide as much information as you can, some things might be useful for helping debugging and understading the problem
-  - Node, Redis, Bull, bull-board versions
+  - Node, Redis, Bull, BullMQ, bull-board versions
   - Sample code that reproduces the problem
   - Some of your environment details
   - Framework you're using (Express, Koa, Hapi, etc).
@@ -186,7 +180,7 @@ cd bull-board
 
 _This project requires that you have [yarn](https://yarnpkg.com/lang/en/) installed_
 
-Also make sure you are running Redis for this project (bull-board's example connects to Redis' default port 6379).
+Also make sure you are running Redis for this project (bull-board's example connects to Redis' default port `6379`).
 
 Now, to try it out locally you can run:
 

diff --git a/packages/api/README.md b/packages/api/README.md
@@ -0,0 +1,20 @@
+# @bull-board/api 🎯
+
+Core server APIs of `bull-board`.
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@bull-board/api">
+    <img alt="npm version" src="https://img.shields.io/npm/v/@bull-board/api">
+  </a>
+  <a href="https://www.npmjs.com/package/bull-board">
+    <img alt="npm downloads" src="https://img.shields.io/npm/dw/bull-board">
+  </a>
+  <a href="https://github.com/vcapretz/bull-board/blob/master/LICENSE">
+    <img alt="licence" src="https://img.shields.io/github/license/vcapretz/bull-board">
+  </a>
+<p>
+
+![UI](https://raw.githubusercontent.com/felixmosh/bull-board/master/screenshots/shot.png)
+![Fails](https://raw.githubusercontent.com/felixmosh/bull-board/master/screenshots/fails.png)
+
+For more info visit the main [README](https://github.com/felixmosh/bull-board#readme)
diff --git a/packages/api/package.json b/packages/api/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@bull-board/api",
   "version": "3.0.0",
-  "description": "Bull-Board common api package",
+  "description": "Core server APIs of bull-board",
   "keywords": [
     "bull",
     "bullmq",

diff --git a/packages/express/README.md b/packages/express/README.md
@@ -0,0 +1,25 @@
+# @bull-board/express 🎯
+
+[Express.js](https://expressjs.com/) server adapter for `bull-board`.
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@bull-board/express">
+    <img alt="npm version" src="https://img.shields.io/npm/v/@bull-board/express">
+  </a>
+  <a href="https://www.npmjs.com/package/bull-board">
+    <img alt="npm downloads" src="https://img.shields.io/npm/dw/bull-board">
+  </a>
+  <a href="https://github.com/vcapretz/bull-board/blob/master/LICENSE">
+    <img alt="licence" src="https://img.shields.io/github/license/vcapretz/bull-board">
+  </a>
+<p>
+
+![UI](https://raw.githubusercontent.com/felixmosh/bull-board/master/screenshots/shot.png)
+![Fails](https://raw.githubusercontent.com/felixmosh/bull-board/master/screenshots/fails.png)
+
+# Usage examples
+1. [Simple express setup](https://github.com/felixmosh/bull-board/tree/master/examples/with-express)
+2. [Basic authentication example](https://github.com/felixmosh/bull-board/tree/master/examples/with-express-auth)
+2. [Multiple instance of the board](https://github.com/felixmosh/bull-board/tree/master/examples/with-multiple-instances)
+
+For more info visit the main [README](https://github.com/felixmosh/bull-board#readme)
diff --git a/packages/fastify/README.md b/packages/fastify/README.md
@@ -0,0 +1,24 @@
+# @bull-board/fastify 🎯
+
+[Fastify.js](https://www.fastify.io/) server adapter for `bull-board`.
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@bull-board/fastify">
+    <img alt="npm version" src="https://img.shields.io/npm/v/@bull-board/fastify">
+  </a>
+  <a href="https://www.npmjs.com/package/bull-board">
+    <img alt="npm downloads" src="https://img.shields.io/npm/dw/bull-board">
+  </a>
+  <a href="https://github.com/vcapretz/bull-board/blob/master/LICENSE">
+    <img alt="licence" src="https://img.shields.io/github/license/vcapretz/bull-board">
+  </a>
+<p>
+
+![UI](https://raw.githubusercontent.com/felixmosh/bull-board/master/screenshots/shot.png)
+![Fails](https://raw.githubusercontent.com/felixmosh/bull-board/master/screenshots/fails.png)
+
+# Usage examples
+1. [Simple fastify setup](https://github.com/felixmosh/bull-board/tree/master/examples/with-fastify)
+
+
+For more info visit the main [README](https://github.com/felixmosh/bull-board#readme)
diff --git a/packages/hapi/README.md b/packages/hapi/README.md
@@ -0,0 +1,23 @@
+# @bull-board/hapi 🎯
+
+[Hapi.js](https://hapi.dev/) server adapter for `bull-board`.
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@bull-board/hapi">
+    <img alt="npm version" src="https://img.shields.io/npm/v/@bull-board/hapi">
+  </a>
+  <a href="https://www.npmjs.com/package/bull-board">
+    <img alt="npm downloads" src="https://img.shields.io/npm/dw/bull-board">
+  </a>
+  <a href="https://github.com/vcapretz/bull-board/blob/master/LICENSE">
+    <img alt="licence" src="https://img.shields.io/github/license/vcapretz/bull-board">
+  </a>
+<p>
+
+![UI](https://raw.githubusercontent.com/felixmosh/bull-board/master/screenshots/shot.png)
+![Fails](https://raw.githubusercontent.com/felixmosh/bull-board/master/screenshots/fails.png)
+
+# Usage examples
+1. [Simple hapi setup](https://github.com/felixmosh/bull-board/tree/master/examples/with-hapi)
+
+For more info visit the main [README](https://github.com/felixmosh/bull-board#readme)
diff --git a/packages/ui/README.md b/packages/ui/README.md
@@ -0,0 +1,20 @@
+# @bull-board/ui 🎯
+
+UI packages of `bull-board`.
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@bull-board/ui">
+    <img alt="npm version" src="https://img.shields.io/npm/v/@bull-board/ui">
+  </a>
+  <a href="https://www.npmjs.com/package/bull-board">
+    <img alt="npm downloads" src="https://img.shields.io/npm/dw/bull-board">
+  </a>
+  <a href="https://github.com/vcapretz/bull-board/blob/master/LICENSE">
+    <img alt="licence" src="https://img.shields.io/github/license/vcapretz/bull-board">
+  </a>
+<p>
+
+![UI](https://raw.githubusercontent.com/felixmosh/bull-board/master/screenshots/shot.png)
+![Fails](https://raw.githubusercontent.com/felixmosh/bull-board/master/screenshots/fails.png)
+
+For more info visit the main [README](https://github.com/felixmosh/bull-board#readme)