adding readme

Dockerfile

@@ -1,5 +1,5 @@
 # Build stage
-FROM golang:1.22.1-bullseye as builder
+FROM golang:1.22.2-bullseye as builder
 
 LABEL author="Dipjyoti Metia"
 LABEL version="1.0"

Makefile

@@ -1,14 +1,19 @@
+.PHONY: test
 test:
  go test ./... -v --tags=integration
 
+.PHONY: build
 build:
  docker compose up -d
 
+.PHONY: clean
 clean:
  docker compose down --rmi all --volumes
 
+.PHONY: code-gen
 code-gen:
  go generate ./...
 
+.PHONY: schema-gen
 schema-gen:
  go run script/avsc2json/main.go schema/avro/expense.avsc > docker/schema/expense.json

README.md

@@ -0,0 +1,10 @@
+# Event Shark: A Serverless Kafka Event Publisher Testing Framework
+
+* Accelerate your Kafka-driven development: Event Shark makes it easy to test consumer applications in isolation.
+* Gain confidence in your consumer code: Simulate real-world publisher behavior for comprehensive testing.
+* Optimize performance: Run targeted performance tests on consumer applications without complex publisher dependencies.
+
+<img src="./docs/assets/Architecture.png" width="800">
+
+Event Shark is a Serverless framework which fill in the gap for kafka event publisher by exposing the eventing as simple json request.
+Using this the consumer applcations can simulate the publisher behaviour and test their systems independently, not just the integration testing this can also help to run the performance testing for the consumer driven applications.

docker-compose.yml

@@ -1,6 +1,6 @@
 version: '3.8'
 services:
- event-publisher:
+ event-shark:
  build:
  context: .
  dockerfile: Dockerfile