From 23d0e13e7550bfd68b92ecd0dfc422ab404a826b Mon Sep 17 00:00:00 2001
From: Shawn Lim <shawn.lim@traveloka.com>
Date: Fri, 15 May 2020 11:25:06 +0800
Subject: [PATCH] Add readme

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6a8914e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+## Redis-backed Distributed Job Queue w/ Rate Limiter
+
+[WORK IN PROGRESS]
+
+- Pending addition of [Rate Limiter](https://www.javadoc.io/doc/org.redisson/redisson/3.10.6/org/redisson/api/RRateLimiter.html)
+- Pending addition of [Grafana](https://grafana.com/docs/grafana/latest/installation/docker/) to check the outgoing rates
+- Pending addition of [pumba](https://github.com/alexei-led/pumba) to simulate failures
+- Pending addition of [karate](https://intuit.github.io/karate/karate-gatling/) for load tests
+
+### Setup
+
+`docker-compose up`
+
+### Test
+
+Queue a job:
+
+```
+curl --request POST \
+  --url http://localhost:8082/queueJob \
+  --header 'content-type: application/json' \
+  --data '{
+	"queueId": "airasia",
+	"name": "spec2",
+	"score": 2.1
+}'
+```
+
+Poll for a job:
+
+```
+curl --request POST \
+  --url http://localhost:8081/pollJob/airasia
+```