redux-cluster 2.0.1 → 2.0.2

package/README.md

@@ -1,15 +1,20 @@
 # Redux Cluster 2.0
 
-[![npm version](https://badge.fury.io/js/redux-cluster.svg)](https://badge.fury.io/js/redux-cluster)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)
+[![npm](https://img.shields.io/npm/v/redux-cluster.svg)](https://www.npmjs.com/package/redux-cluster)
+[![npm](https://img.shields.io/npm/dy/redux-cluster.svg)](https://www.npmjs.com/package/redux-cluster)
+[![NpmLicense](https://img.shields.io/npm/l/redux-cluster.svg)](https://www.npmjs.com/package/redux-cluster)
+![GitHub last commit](https://img.shields.io/github/last-commit/siarheidudko/redux-cluster.svg)
+![GitHub release](https://img.shields.io/github/release/siarheidudko/redux-cluster.svg)
 
 A modern TypeScript library for synchronizing Redux stores across multiple processes and machines using TCP, Unix Domain Sockets, and IPC.
 
+> 🌐 **Need WebSocket support for browsers?** Check out [redux-cluster-ws](https://www.npmjs.com/package/redux-cluster-ws) - our companion package that extends Redux Cluster with WebSocket transport for browser clients.
+
 ## 🌟 Key Features
 
 - 🔄 **Real-time State Synchronization** across multiple processes/machines
 - 🌐 **Multiple Transport Options**: TCP, Unix Domain Sockets, IPC
+- 🌍 **WebSocket Support**: Available via [redux-cluster-ws](https://www.npmjs.com/package/redux-cluster-ws)
 - 📡 **Bidirectional Communication** - any node can dispatch actions
 - 🔒 **Built-in Security** with authentication and IP banning
 - ⚡ **High Performance** with optimized networking and compression
@@ -261,8 +266,34 @@ See the [examples/](./examples/) directory for complete working examples:
 - **[File Socket](./examples/file-socket/)** - Local IPC via Unix sockets
 - **[Basic Store](./examples/basic/)** - Local Redux store without networking
 
+> 🌐 **WebSocket Examples**: For browser integration examples with WebSocket transport, visit the [redux-cluster-ws examples](https://github.com/siarheidudko/redux-cluster-ws/tree/main/examples).
+
 Each example includes a README with step-by-step instructions.
 
+## 📦 Related Packages
+
+### redux-cluster-ws
+
+WebSocket transport layer for Redux Cluster, enabling browser client support:
+
+```bash
+npm install redux-cluster-ws
+```
+
+**Features:**
+
+- 🌐 WebSocket server and client
+- 🔗 Seamless integration with Redux Cluster
+- 🖥️ Browser support for web applications  
+- 📱 Real-time state synchronization to browsers
+- 🔒 Same security features as core package
+
+**Links:**
+
+- 📋 [NPM Package](https://www.npmjs.com/package/redux-cluster-ws)
+- 📖 [Documentation](https://github.com/siarheidudko/redux-cluster-ws)
+- 🎯 [Examples](https://github.com/siarheidudko/redux-cluster-ws/tree/main/examples)
+
 ## 🧪 Testing
 
 ```bash
@@ -299,7 +330,7 @@ Benchmark results:
 ## 🗺️ Roadmap
 
 - [ ] **Redis Transport** - Redis pub/sub for clustering
-- [ ] **WebSocket Transport** - Browser client support
+- [x] **WebSocket Transport** - Available in [redux-cluster-ws](https://www.npmjs.com/package/redux-cluster-ws)
 - [ ] **Conflict Resolution** - CRDT-based conflict resolution
 - [ ] **Persistence Layer** - Automatic state persistence
 - [ ] **Monitoring Dashboard** - Real-time cluster monitoring
@@ -307,7 +338,11 @@ Benchmark results:
 
 ## 🤝 Contributing
 
-Contributions are welcome! Please read our [Contributing Guidelines](./CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md).
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
 
 ### Development Setup
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redux-cluster",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "type": "module",
   "description": "TypeScript cluster module for Redux that synchronizes Redux stores across cluster processes via IPC and TCP sockets",
   "main": "dist/cjs/index.js",
@@ -49,6 +49,7 @@
     "build:pkg": "./scripts/create-package-files.sh",
     "build:watch": "tsc --watch",
     "clean": "rm -rf dist",
+    "update": "eval \"$(node -e 'const t = require(`./package.json`);const ignore = require(`./ignoreUpdatesModules.json`);console.log(`npm i ${(Object.keys(t.dependencies || {}).filter((e)=>ignore.base.indexOf(e) === -1).map((e)=>(`${e}@latest`)).join(` `))} --save&&npm i ${(Object.keys(t.devDependencies || {}).filter((e)=>ignore.dev.indexOf(e) === -1).map((e)=>(`${e}@latest`)).join(` `))} --save-dev`);')\"",
     "prepublishOnly": "npm run clean && npm run build",
     "test": "npm run test:all",
     "test:all": "node --test --import tsx tests/unit.test.ts tests/error.test.ts tests/transport.test.ts",
@@ -96,8 +97,8 @@
   },
   "devDependencies": {
     "@types/node": "^20.11.17",
-    "@typescript-eslint/eslint-plugin": "^8.42.0",
-    "@typescript-eslint/parser": "^8.42.0",
+    "@typescript-eslint/eslint-plugin": "^8.43.0",
+    "@typescript-eslint/parser": "^8.43.0",
     "eslint": "^9.35.0",
     "ts-node": "^10.9.2",
     "tsx": "^4.20.5",