chore: update readme

flyingImer · Feb 28, 2022 · 9a0f8ee · 9a0f8ee
1 parent c919e28
commit 9a0f8ee
Showing 1 changed file with 16 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,16 @@
-# replace this
+# cdk-concurrency-controller
+
+![Release](https://github.com/flyingImer/cdk-concurrency-controller/workflows/Release/badge.svg)
+
+> Controlling concurrency in your distributed systems
+
+## Warning
+Currently it temporarily supports monocdk (CDK v1), but scheduled to migrate to CDK v2.
+
+## Install
+
+TypeScript/JavaScript:
+
+```console
+$ npm install cdk-concurrency-controller
+```