From 2efbedb76dcb5dcb92b89fab8f6bd60fca5f914e Mon Sep 17 00:00:00 2001
From: Nicholas Kalar <nick@kalar.codes>
Date: Fri, 7 Nov 2025 17:15:40 -0500
Subject: [PATCH] setup README and requirements

---
 README.md        | 24 ++++++++++++++++++++++++
 requirements.txt |  1 +
 2 files changed, 25 insertions(+)
 create mode 100644 README.md
 create mode 100644 requirements.txt

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..34eb230
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Kafka Example
+
+This is a very simple application to demonstrate how to set up a Kafka instance, create a consumer and a producer, and send and receive messages.
+
+## Setup
+
+1) Create a virtual environment
+2) Install required libraries
+```zsh
+pip3 install -r requirements.txt 
+```
+3) Run Kafka using Docker Compose
+```zsh
+docker compose up
+```
+4) Run tracker.py
+```zsh
+python3 src/tracker.py
+```
+5) Run producer.py
+```zsh 
+python3 src/producer.py
+```
+6) Confirm messages in terminal
\ No newline at end of file
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..52bd32e
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1 @@
+confluent-kafka
\ No newline at end of file