Skip to content

Commit b5aa53a

Browse files
committed
docs: update READMEs (v10.1.0 → next)
1 parent 22dfef0 commit b5aa53a

File tree

8 files changed

+63
-63
lines changed

8 files changed

+63
-63
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
[![RedisSMQ](./logo.png)](https://github.com/weyoss/redis-smq)
22

3-
[![Stable](https://img.shields.io/npm/v/redis-smq/latest?style=flat-square&label=redis-smq%40latest)](https://github.com/weyoss/redis-smq/releases/latest)
4-
[![Build (master)](https://img.shields.io/github/actions/workflow/status/weyoss/redis-smq/tests.yml?branch=master&style=flat-square)](https://github.com/weyoss/redis-smq/actions/workflows/tests.yml?query=branch%3Amaster)
5-
[![Code Quality (master)](https://img.shields.io/github/actions/workflow/status/weyoss/redis-smq/codeql.yml?branch=master&style=flat-square&label=quality)](https://github.com/weyoss/redis-smq/actions/workflows/codeql.yml?query=branch%3Amaster)
3+
[![Pre-release (next)](https://img.shields.io/npm/v/redis-smq/next?style=flat-square&label=redis-smq%40next)](https://github.com/weyoss/redis-smq/releases)
4+
[![Build (next)](https://img.shields.io/github/actions/workflow/status/weyoss/redis-smq/tests.yml?branch=next&style=flat-square)](https://github.com/weyoss/redis-smq/actions/workflows/tests.yml?query=branch%3Anext)
5+
[![Code Quality (next)](https://img.shields.io/github/actions/workflow/status/weyoss/redis-smq/codeql.yml?branch=next&style=flat-square&label=quality)](https://github.com/weyoss/redis-smq/actions/workflows/codeql.yml?query=branch%3Anext)
66

7-
> 💡 **Note:** You are on the stable `master` branch. For the latest features (including breaking changes), check the [`next` branch](https://github.com/weyoss/redis-smq/tree/next).
7+
> 💡 **Note:** You are viewing the `next` branch with upcoming features. For stable releases, check the [`master` branch](https://github.com/weyoss/redis-smq/tree/master).
88
99
A high-performance Redis message queue for Node.js — simple to use, built for scale.
1010

@@ -49,7 +49,7 @@ A high-performance Redis message queue for Node.js — simple to use, built for
4949

5050
```bash
5151
# Core packages
52-
npm install redis-smq redis-smq-common --save
52+
npm install redis-smq@next redis-smq-common@next --save
5353

5454
# Pick a Redis client
5555
npm install ioredis --save

packages/redis-smq-benchmarks/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# RedisSMQ Benchmarks
22

3-
[![Stable](https://img.shields.io/npm/v/redis-smq-benchmarks/latest?style=flat-square&label=redis-smq-benchmarks%40latest)](https://github.com/weyoss/redis-smq/releases/latest)
4-
[![Code Coverage (master)](https://img.shields.io/codecov/c/github/weyoss/redis-smq/master?flag=redis-smq-benchmarks&style=flat-square)](https://app.codecov.io/github/weyoss/redis-smq/tree/master/packages/redis-smq-benchmarks)
3+
[![Pre-release (next)](https://img.shields.io/npm/v/redis-smq-benchmarks/next?style=flat-square&label=redis-smq-benchmarks%40next)](https://github.com/weyoss/redis-smq/releases)
4+
[![Code Coverage (next)](https://img.shields.io/codecov/c/github/weyoss/redis-smq/next?flag=redis-smq-benchmarks&style=flat-square)](https://app.codecov.io/github/weyoss/redis-smq/tree/next/packages/redis-smq-benchmarks)
55

6-
> 💡 **Note:** You are on the stable `master` branch. For the latest features (including breaking changes), check the [`next` branch](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-benchmarks).
6+
> 💡 **Note:** You are viewing the `next` branch with upcoming features. For stable releases, check the [`master` branch](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-benchmarks).
77
88
A comprehensive benchmarking suite for RedisSMQ message queue system, measuring throughput, latency, and end-to-end
99
performance under various workloads.
@@ -28,7 +28,7 @@ This benchmark suite provides tools to measure RedisSMQ performance across diffe
2828
### Installation
2929

3030
```bash
31-
npm install redis-smq redis-smq-common redis-smq-benchmarks --save
31+
npm install redis-smq@next redis-smq-common@next redis-smq-benchmarks@next --save
3232
```
3333

3434
## ⚙️ Configuration
@@ -185,4 +185,4 @@ End-to-End:
185185

186186
## License
187187

188-
RedisSMQ Benchmarks is released under the [MIT License](https://github.com/weyoss/redis-smq/tree/master/LICENSE).
188+
RedisSMQ Benchmarks is released under the [MIT License](https://github.com/weyoss/redis-smq/tree/next/LICENSE).

packages/redis-smq-ci/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# RedisSMQ CI
22

3-
> 💡 **Note:** You are on the stable `master` branch. For the latest features (including breaking changes), check the [`next` branch](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-ci).
3+
> 💡 **Note:** You are viewing the `next` branch with upcoming features. For stable releases, check the [`master` branch](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-ci).
44
55
CLI tools for RedisSMQ - Utilities for continuous integration and release management.
66

@@ -220,4 +220,4 @@ git commit -m "docs: update commit hashes after history rewrite"
220220

221221
## License
222222

223-
RedisSMQ CI Library is released under the [MIT License](https://github.com/weyoss/redis-smq/tree/master/LICENSE).
223+
RedisSMQ CI Library is released under the [MIT License](https://github.com/weyoss/redis-smq/tree/next/LICENSE).

packages/redis-smq-common/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# RedisSMQ Common Library
22

3-
[![Stable](https://img.shields.io/npm/v/redis-smq-common/latest?style=flat-square&label=redis-smq-common%40latest)](https://github.com/weyoss/redis-smq/releases/latest)
4-
[![Code Coverage (master)](https://img.shields.io/codecov/c/github/weyoss/redis-smq/master?flag=redis-smq-common&style=flat-square)](https://app.codecov.io/github/weyoss/redis-smq/tree/master/packages/redis-smq-common)
3+
[![Pre-release (next)](https://img.shields.io/npm/v/redis-smq-common/next?style=flat-square&label=redis-smq-common%40next)](https://github.com/weyoss/redis-smq/releases)
4+
[![Code Coverage (next)](https://img.shields.io/codecov/c/github/weyoss/redis-smq/next?flag=redis-smq-common&style=flat-square)](https://app.codecov.io/github/weyoss/redis-smq/tree/next/packages/redis-smq-common)
55

6-
> 💡 **Note:** You are on the stable `master` branch. For the latest features (including breaking changes), check the [`next` branch](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-common).
6+
> 💡 **Note:** You are viewing the `next` branch with upcoming features. For stable releases, check the [`master` branch](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-common).
77
88
A shared foundation for the RedisSMQ ecosystem.
99
This package provides essential components and utilities used by RedisSMQ and related packages, helping you configure
@@ -23,9 +23,9 @@ Redis clients, structure logging, and reuse core types across the stack.
2323
Install the package:
2424

2525
```bash
26-
npm install redis-smq-common
26+
npm install redis-smq-common@next
2727
# or
28-
pnpm add redis-smq-common
28+
pnpm add redis-smq-common@next
2929
```
3030

3131
This package works with multiple Redis clients. Install one of the supported clients based on your needs:
@@ -46,19 +46,19 @@ Note: Redis clients are optional peer dependencies; pick one and configure it in
4646

4747
## Version compatibility
4848

49-
Always install matching versions of RedisSMQ packages to ensure compatibility. See [version compatibility](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq/docs/version-compatibility.md) for details.
49+
Always install matching versions of RedisSMQ packages to ensure compatibility. See [version compatibility](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq/docs/version-compatibility.md) for details.
5050

5151
## Documentation
5252

53-
For in-depth guides and API references, see [the documentation page](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-common/docs/README.md).
53+
For in-depth guides and API references, see [the documentation page](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-common/docs/README.md).
5454

5555
## Related packages
5656

57-
- [redis-smq](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq/README.md): Core message queue for Node.js
58-
- [redis-smq-rest-api](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-rest-api/README.md): REST API with OpenAPI v3 and Swagger UI
59-
- [redis-smq-web-server](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-web-server/README.md): Web server for hosting the UI and proxying/serving the API
60-
- [redis-smq-web-ui](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-web-ui/README.md): SPA for monitoring and managing RedisSMQ
57+
- [redis-smq](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq/README.md): Core message queue for Node.js
58+
- [redis-smq-rest-api](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-rest-api/README.md): REST API with OpenAPI v3 and Swagger UI
59+
- [redis-smq-web-server](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-web-server/README.md): Web server for hosting the UI and proxying/serving the API
60+
- [redis-smq-web-ui](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-web-ui/README.md): SPA for monitoring and managing RedisSMQ
6161

6262
## License
6363

64-
RedisSMQ Common Library is released under the [MIT License](https://github.com/weyoss/redis-smq/tree/master/LICENSE).
64+
RedisSMQ Common Library is released under the [MIT License](https://github.com/weyoss/redis-smq/tree/next/LICENSE).

packages/redis-smq-rest-api/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# RedisSMQ REST API
22

3-
[![Stable](https://img.shields.io/npm/v/redis-smq-rest-api/latest?style=flat-square&label=redis-smq-rest-api%40latest)](https://github.com/weyoss/redis-smq/releases/latest)
4-
[![Code Coverage (master)](https://img.shields.io/codecov/c/github/weyoss/redis-smq/master?flag=redis-smq-rest-api&style=flat-square)](https://app.codecov.io/github/weyoss/redis-smq/tree/master/packages/redis-smq-rest-api)
3+
[![Pre-release (next)](https://img.shields.io/npm/v/redis-smq-rest-api/next?style=flat-square&label=redis-smq-rest-api%40next)](https://github.com/weyoss/redis-smq/releases)
4+
[![Code Coverage (next)](https://img.shields.io/codecov/c/github/weyoss/redis-smq/next?flag=redis-smq-rest-api&style=flat-square)](https://app.codecov.io/github/weyoss/redis-smq/tree/next/packages/redis-smq-rest-api)
55

6-
> 💡 **Note:** You are on the stable `master` branch. For the latest features (including breaking changes), check the [`next` branch](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-rest-api).
6+
> 💡 **Note:** You are viewing the `next` branch with upcoming features. For stable releases, check the [`master` branch](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-rest-api).
77
88
RedisSMQ REST API provides an HTTP interface enabling any web-capable application to interact with the RedisSMQ message
99
queue using a RESTful API.
@@ -20,7 +20,7 @@ queue using a RESTful API.
2020

2121
```bash
2222
# Using npm
23-
npm install redis-smq redis-smq-common redis-smq-rest-api --save
23+
npm install redis-smq@next redis-smq-common@next redis-smq-rest-api@next --save
2424
```
2525

2626
Don't forget to install a Redis client:
@@ -33,19 +33,19 @@ npm install ioredis --save
3333

3434
## Version Compatibility
3535

36-
Always install matching versions of RedisSMQ packages to ensure compatibility. See [version compatibility](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq/docs/version-compatibility.md) for details.
36+
Always install matching versions of RedisSMQ packages to ensure compatibility. See [version compatibility](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq/docs/version-compatibility.md) for details.
3737

3838
## Documentation
3939

40-
For in-depth guides and API references, see [the documentation page](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-rest-api/docs/README.md):
40+
For in-depth guides and API references, see [the documentation page](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-rest-api/docs/README.md):
4141

4242
## Related packages
4343

44-
- [redis-smq](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq/README.md): Core message queue
45-
- [redis-smq-common](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-common/README.md): Shared components/utilities
46-
- [redis-smq-web-server](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-web-server/README.md): Static hosting + in-process or proxied API
47-
- [redis-smq-web-ui](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-web-ui/README.md): SPA for monitoring and managing RedisSMQ
44+
- [redis-smq](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq/README.md): Core message queue
45+
- [redis-smq-common](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-common/README.md): Shared components/utilities
46+
- [redis-smq-web-server](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-web-server/README.md): Static hosting + in-process or proxied API
47+
- [redis-smq-web-ui](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-web-ui/README.md): SPA for monitoring and managing RedisSMQ
4848

4949
## License
5050

51-
RedisSMQ REST API is released under the [MIT License](https://github.com/weyoss/redis-smq/tree/master/LICENSE).
51+
RedisSMQ REST API is released under the [MIT License](https://github.com/weyoss/redis-smq/tree/next/LICENSE).

packages/redis-smq-web-server/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# RedisSMQ Web Server
22

3-
[![Stable](https://img.shields.io/npm/v/redis-smq-web-server/latest?style=flat-square&label=redis-smq-web-server%40latest)](https://github.com/weyoss/redis-smq/releases/latest)
4-
[![Code Coverage (master)](https://img.shields.io/codecov/c/github/weyoss/redis-smq/master?flag=redis-smq-web-server&style=flat-square)](https://app.codecov.io/github/weyoss/redis-smq/tree/master/packages/redis-smq-web-server)
3+
[![Pre-release (next)](https://img.shields.io/npm/v/redis-smq-web-server/next?style=flat-square&label=redis-smq-web-server%40next)](https://github.com/weyoss/redis-smq/releases)
4+
[![Code Coverage (next)](https://img.shields.io/codecov/c/github/weyoss/redis-smq/next?flag=redis-smq-web-server&style=flat-square)](https://app.codecov.io/github/weyoss/redis-smq/tree/next/packages/redis-smq-web-server)
55

6-
> 💡 **Note:** You are on the stable `master` branch. For the latest features (including breaking changes), check the [`next` branch](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-web-server).
6+
> 💡 **Note:** You are viewing the `next` branch with upcoming features. For stable releases, check the [`master` branch](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-web-server).
77
88
A lightweight server that brings the RedisSMQ management ecosystem to life. It serves the official Web UI and provides
99
the REST API through two flexible modes of operation:
@@ -21,7 +21,7 @@ the REST API through two flexible modes of operation:
2121

2222
```bash
2323
# Using npm
24-
npm install redis-smq redis-smq-common redis-smq-rest-api redis-smq-web-ui redis-smq-web-server --save
24+
npm install redis-smq@next redis-smq-common@next redis-smq-rest-api@next redis-smq-web-ui@next redis-smq-web-server@next --save
2525
```
2626

2727
Don't forget to install a Redis client:
@@ -34,19 +34,19 @@ npm install ioredis --save
3434

3535
## Version Compatibility
3636

37-
Always install matching versions of RedisSMQ packages to ensure compatibility. See [version compatibility](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq/docs/version-compatibility.md) for details.
37+
Always install matching versions of RedisSMQ packages to ensure compatibility. See [version compatibility](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq/docs/version-compatibility.md) for details.
3838

3939
## Documentation
4040

41-
For in-depth guides and API references, see [the documentation page](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-web-server/docs/README.md).
41+
For in-depth guides and API references, see [the documentation page](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-web-server/docs/README.md).
4242

4343
## Related packages
4444

45-
- [redis-smq](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq/README.md): Core message queue
46-
- [redis-smq-common](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-common/README.md): Shared components/utilities
47-
- [redis-smq-rest-api](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-rest-api/README.md): REST API with OpenAPI v3 and Swagger UI
48-
- [redis-smq-web-ui](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-web-ui/README.md): SPA for monitoring and managing RedisSMQ
45+
- [redis-smq](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq/README.md): Core message queue
46+
- [redis-smq-common](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-common/README.md): Shared components/utilities
47+
- [redis-smq-rest-api](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-rest-api/README.md): REST API with OpenAPI v3 and Swagger UI
48+
- [redis-smq-web-ui](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-web-ui/README.md): SPA for monitoring and managing RedisSMQ
4949

5050
## License
5151

52-
RedisSMQ Web Server is released under the [MIT License](https://github.com/weyoss/redis-smq/tree/master/LICENSE).
52+
RedisSMQ Web Server is released under the [MIT License](https://github.com/weyoss/redis-smq/tree/next/LICENSE).

0 commit comments

Comments
 (0)