@jetit/publisher 1.0.6 → 1.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jetit/publisher",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "type": "commonjs",
   "dependencies": {
     "@jetit/id": "0.0.6",
@@ -12,6 +12,5 @@
     "tslib": "2.5.0"
   },
   "main": "./src/index.js",
-  "types": "./src/index.d.ts",
-  "readme": "README.md"
+  "types": "./src/index.d.ts"
 }

package/src/README.md

@@ -1,43 +0,0 @@
-# publisher
-
-publisher is a library for implementing an event-driven architecture using Redis PUB/SUB and Redis Streams. It provides a simple and scalable mechanism for publishing and consuming events in real-time, and supports features such as message deduplication, consumer group management, and scheduled event publishing.
-
-## Simple Example
-
-```typescript
-import { Publisher, EventData } from '@jetit/streams';
-
-// Create an instance of the publisher
-const streams = new Streams('Websockets');
-
-// Publish an event
-const eventData: EventData<{ message: string }> = {
-    eventName: 'my-event',
-    data: { message: 'Hello, world!' }
-};
-
-await streams.publish(eventData);
-
-// Subscribe to an event
-streams.listen('my-event').subscribe(event => {
-    console.log(`Received event: ${event.eventName}`, event.data);
-});
-```
-
-## Possible use cases
-
-1. Microservices communication: If your system is composed of multiple microservices, the publisher can be used to facilitate communication between them by publishing and listening to events.
-
-2. Event sourcing and CQRS: In an event-sourced system, the publisher can be used to store and process events that represent the state changes of the system, enabling Command Query Responsibility Segregation (CQRS) by separating the read and write models.
-
-3. Task queues: The publisher can be used to create task queues for distributing workloads among different worker instances, ensuring that tasks are processed in the order they were created.
-
-4. Data streaming and processing: The publisher can be used to ingest and process large volumes of data in real-time, such as log files, clickstream data, or other event-based data.
-
-5. Distributed system coordination: In a distributed system, the publisher can be used for coordination between different components, such as managing leader election or maintaining configuration information.
-
-6. Real-time analytics and monitoring: The publisher can be used to collect and process real-time analytics data, such as user behavior, application performance metrics, or system monitoring information.
-
-7. Event-driven workflows: You can use the publisher to create event-driven workflows, where each step in the workflow is triggered by the completion of a previous step. This can be useful for orchestrating complex, multi-step processes.
-
-8. Message broadcasting: The publisher can be used to broadcast messages to multiple consumers or subscribers, allowing for efficient and scalable communication in applications with many components or services.