Add quickstart

Author: milindl

QUICKSTART.md

@@ -0,0 +1,62 @@
+# Basic Producer Example
+
+```javascript
+const { Kafka } = require('../..').KafkaJS
+
+async function producerStart() {
+    const producer = new Kafka().producer({
+        'bootstrap.servers': '<fill>',
+    });
+
+    await producer.connect();
+
+    const deliveryReports = await producer.send({
+            topic: 'topic2',
+            messages: [
+                { value: 'v222', partition: 0 },
+                { value: 'v11', partition: 0, key: 'x' },
+            ]
+        });
+
+    await producer.disconnect();
+}
+
+producerStart();
+```
+
+# Basic Consumer Example
+
+```javascript
+const { Kafka } = require('../..').KafkaJS
+
+async function consumerStart() {
+  const consumer = new Kafka().consumer({
+    'bootstrap.servers': '<fill>',
+    'group.id': 'test',
+    'auto.offset.reset': 'earliest',
+  });
+
+  await consumer.connect();
+
+  await consumer.subscribe({ topics: [ "topic" ] });
+
+  consumer.run({
+    eachMessage: async ({ topic, partition, message }) => {
+      console.log({
+        topic,
+        partition,
+        offset: message.offset,
+        key: message.key?.toString(),
+        value: message.value.toString(),
+      });
+    },
+  });
+
+  // When done consuming
+  // await consumer.disconnect();
+}
+
+consumerStart();
+```
+
+See the examples in the [examples](examples) directory for more in-depth examples.

README.md

@@ -36,8 +36,8 @@ __This library currently uses `librdkafka` based off of the master branch.__
 The following configurations are supported for this early access preview:
 
 * Any supported version of Node.js (The two LTS versions, 18 and 20, and the latest version, 21).
-* Linux (x64 and arm64) - only glibc, not musl/alpine.
-* macOS - arm64/m1 only
+* Linux (x64 and arm64) - both glibc and musl/alpine.
+* macOS - arm64/m1.
 
 Installation on any of these platforms is meant to be seamless, without any C/C++ compilation required. It can be installed
 from GitHub:
@@ -48,7 +48,7 @@ $ npm install "git+ssh://git@github.com/confluentinc/confluent-kafka-js.git#v0.1
 
 # Getting Started
 
-1. If you're starting afresh, you can use the [quickstart guide](QUICKSTART.md) (TBA).
+1. If you're starting afresh, you can use the [quickstart guide](QUICKSTART.md).
 2. If you're migrating from `kafkajs`, you can use the [migration guide](MIGRATION.md#kafkajs).
 2. If you're migrating from `node-rdkafka`, you can use the [migration guide](MIGRATION.md#node-rdkafka).