kafka-crab-js 0.0.9 → 0.0.10

package/README.md

@@ -1,16 +1,77 @@
-Kafka Crab Js
--------------
+# Kafka Crab Js
 
 **Blazingly Fast Kafka Client for NodeJs**
 
 Kafka-Crab-JS is a powerful Node.js library that allows developers to interact with Apache Kafka using Rust programming language, seamlessly integrated with Node.js applications. This documentation provides an overview of the Kafka-Crab-JS library, including installation instructions, usage guidelines, and examples.
 
+The plugin can be found on [npm](https://www.npmjs.com/package/kafka-crab-js) and the source code is available on [GitHub](https://github.com/inaiat/kafka-crab-js).
 
-# Installation
+## Table of Contents
+1. [Installation](#installation)
+2. [Usage](#usage)
+   - [Client](#client)
+   - [Producer](#producer)
+   - [Consumer](#consumer)
+3. [Examples](#examples)
 
-To use Kafka-Crab-JS in your Node.js project, follow the steps below:
 
-todo
+## Installation
+To use Kafka Crab JS, you need to have Node.js and npm (Node Package Manager) installed on your system. Once you have them set up, you can install the plugin by running the following command:
 
-# Examples
-todo
+```shell
+npm install kafka-crab-js
+```
+## Usage
+### Client
+Creating a Client Instance
+Next, you can create a client instance by specifying the Kafka broker(s) and other optional configurations:
+
+```javascript
+import { KafkaClient }
+
+const kafkaClient = new KafkaClient({
+  brokers: 'localhost:29092',
+  clientId: 'my-id'});
+```
+### Producer
+The producer component allows you to send messages to Kafka topics.
+
+```javascript
+const result = await producer.send({
+    topic: 'my-js-topic',
+    key: Buffer.from('abc'),
+    value: Buffer.from(`{"name":"Elizeu Drummond","phone":"55219123456"}`),
+    headers: {key: Buffer.from('value1')},
+});
+console.log('Message sent with offset:', result);
+```
+
+
+### Consumer
+
+**Creating a Consumer Instance**
+
+Create a consumer instance by specifying the Kafka broker(s), group ID, and other optional configurations:
+
+```javascript
+const consumer = kafkaClient.createConsumer({
+  topic: 'my-js-topic',
+  groupId: 'my-js-group',
+  retryStrategy: {
+    retries: 3,
+  },
+});
+```
+
+You can consume messages using the run startConsumer:
+
+```javascript
+consumer.startConsumer(async (error, value) => {
+  const message = JSON.parse(value.toString());
+  const content = await process_my_message(message);
+  return ConsumerResult.Ok;
+});
+```
+## Examples
+
+You can find examples of using Kafka Crab JS in the [GitHub repository](https://github.com/inaiat/kafka-crab-js).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kafka-crab-js",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "main": "index.js",
   "types": "index.d.ts",
   "napi": {
@@ -50,8 +50,8 @@
   },
   "packageManager": "yarn@3.6.0",
   "optionalDependencies": {
-    "kafka-crab-js-darwin-arm64": "0.0.9",
-    "kafka-crab-js-darwin-x64": "0.0.9",
-    "kafka-crab-js-linux-x64-gnu": "0.0.9"
+    "kafka-crab-js-darwin-arm64": "0.0.10",
+    "kafka-crab-js-darwin-x64": "0.0.10",
+    "kafka-crab-js-linux-x64-gnu": "0.0.10"
   }
 }