redis-smq-rest-api 8.0.1 → 8.0.2

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.0.2](https://github.com/weyoss/redis-smq/compare/v8.0.1...v8.0.2) (2025-04-14)
+
+### 📝 Documentation
+
+- reorganize and enhance documentation across packages ([212fe75](https://github.com/weyoss/redis-smq/commit/212fe75143f1c446045c346e460065215e98f1d7))
+
 ## [8.0.1](https://github.com/weyoss/redis-smq/compare/v8.0.0...v8.0.1) (2025-04-13)
 
 ### 📝 Documentation

package/README.md

@@ -3,31 +3,50 @@
 [![Latest Release](https://img.shields.io/github/v/release/weyoss/redis-smq?include_prereleases&label=release&color=green&style=flat-square)](https://github.com/weyoss/redis-smq/releases)
 [![Code Coverage](https://img.shields.io/codecov/c/github/weyoss/redis-smq?flag=redis-smq-rest-api&style=flat-square)](https://app.codecov.io/github/weyoss/redis-smq/tree/master/packages/redis-smq-rest-api)
 
-This package offers an HTTP interface which allows any web capable application to interact with the RedisSMQ
-message queue using a RESTful API.
+RedisSMQ REST API provides an HTTP interface enabling any web-capable application to interact with the RedisSMQ message 
+queue using a RESTful API.
 
 ## Features
 
-- A clean and simple implementation as always :).
-- Strict Request/Response validation based on [JSON Schema](https://json-schema.org/).
-- Native [OpenAPI v3](https://www.openapis.org/) support and [Swagger](https://swagger.io/) for developers.
-- Rigorously tested codebase with code coverage no less than 90%.
-- Both ESM & CJS modules are supported.
+- 🚀 Clean and efficient implementation
+- ✅ Strict request/response validation using [JSON Schema](https://json-schema.org/)
+- 📚 Native [OpenAPI v3](https://www.openapis.org/) support and [Swagger UI](https://swagger.io/)
+- 🧪 90%+ code coverage with extensive testing
+- 📦 Support for both ESM & CJS modules
+
+
+## Prerequisites
+
+- [RedisSMQ V8](https://github.com/weyoss/redis-smq) latest release.
 
 ## Installation
 
-```shell
-npm i redis-smq-rest-api --save
+```bash
+# Using npm
+npm install redis-smq-rest-api --save
+
+# Using yarn
+yarn add redis-smq-rest-api
+
+# Using pnpm
+pnpm add redis-smq-rest-api
 ```
 
-### Prerequisites
+## Version Compatibility
 
-- [RedisSMQ V8](https://github.com/weyoss/redis-smq) latest release.
+⚠️ Important: Always install matching versions of RedisSMQ packages to ensure compatibility.
+
+```bash
+npm install redis-smq@x.x.x redis-smq-rest-api@x.x.x @redis-smq/common@x.x.x
+```
+
+See [version compatibility](https://github.com/weyoss/redis-smq/blob/master/packages/redis-smq/docs/version-compatibility.md) for details.
 
 ## Configuration
 
-The REST API configuration extends [RedisSMQ Configuration](https://github.com/weyoss/redis-smq/blob/master/docs/configuration.md)
-while adding the API server configuration.
+The REST API configuration extends the base [RedisSMQ configuration](https://github.com/weyoss/redis-smq/blob/master/packages/redis-smq/docs/configuration.md) with additional API server settings.
+
+### Configuration Options
 
 ```typescript
 export type THttpApiConfig = {
@@ -41,6 +60,27 @@ export interface IRedisSMQHttpApiConfig extends IRedisSMQConfig {
 }
 ```
 
+### Configuration Examples
+
+```typescript
+import { RedisSmqRestApi } from 'redis-smq-rest-api';
+
+// Basic configuration
+const basicConfig: IRedisSMQHttpApiConfig = {
+  redis: {
+    client: 'ioredis',
+    options: {
+      host: '127.0.0.1',
+      port: 6379,
+    },
+  },
+  apiServer: {
+    host: '127.0.0.1',
+    port: 7210,
+  },
+};
+```
+
 ## Usage
 
 ```typescript
@@ -64,11 +104,28 @@ const apiServer = new RedisSmqRestApi(config);
 apiServer.run();
 ```
 
-## API Reference
+## API Documentation
+
+### Swagger UI
+
+Access the interactive API documentation at:
+
+```text
+http://<HOSTNAME>:<PORT>/docs
+```
+
+### OpenAPI Specification
+
+Download the OpenAPI specification at:
+
+```text
+http://<HOSTNAME>:<PORT>/assets/openapi-specs.json
+```
+
+## Available Endpoints
 
-Once your RedisSMQ API server is up and running you may view the API Reference and try it directly from
-the Swagger UI which is accessible via `http://<HOSTAME:PORT>/docs`.
+For detailed endpoint documentation, refer to the Swagger UI.
 
-## OpenAPI Specification
+## License
 
-The OpenAPI specification is available at `http://<HOSTAME:PORT>/assets/openapi-specs.json`
+This project is licensed under is released under the [MIT License](https://github.com/weyoss/redis-smq/blob/master/LICENSE).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redis-smq-rest-api",
-  "version": "8.0.1",
+  "version": "8.0.2",
   "description": "A RESTful API for RedisSMQ",
   "author": "Weyoss <weyoss@protonmail.com>",
   "license": "MIT",
@@ -61,8 +61,8 @@
     "uuid": "11.1.0"
   },
   "peerDependencies": {
-    "redis-smq": "^8.0.1",
-    "redis-smq-common": "^8.0.1"
+    "redis-smq": "^8.0.2",
+    "redis-smq-common": "^8.0.2"
   },
   "devDependencies": {
     "@types/json-schema": "7.0.15",