feat: setup eventcatalog README

Signed-off-by: Brooks Townsend <[email protected]>
cosmonic · Dec 13, 2023 · 5536af2 · 5536af2
1 parent 967c317
commit 5536af2
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 41 deletions.
diff --git a/Justfile b/Justfile
@@ -1,6 +1,8 @@
 set shell := ["bash", "-cu"]
 
 build:
+    # Ensure events are up-to-date
+    cd eventcatalog && npm run build
     # Build all the actors using `wash build`
     for dir in $(find . -type f -name 'Cargo.toml' | xargs -n1 dirname | rg -v node_modules); do \
         echo "Building $dir"; \

diff --git a/eventcatalog/README.md b/eventcatalog/README.md
@@ -1 +1,23 @@
-# My Event Catalog
+# Bank Account Event Catalog
+
+This is the event catalog for the bank account service. You can either run the event catalog locally or compile it into a Cosmonic component.
+
+## Running the Event Catalog
+
+```bash
+npm install
+npm run start
+```
+
+## Compiling Cosmonic Component
+
+```bash
+npm install
+npm run build
+cd actor
+wash build
+```
+
+## All Events
+
+![All Bank Account Events](./all_events.png)
diff --git a/eventcatalog/actor/README.md b/eventcatalog/actor/README.md
diff --git a/eventcatalog/all_events.png b/eventcatalog/all_events.png
diff --git a/eventcatalog/package.json b/eventcatalog/package.json
@@ -1,6 +1,6 @@
 {
   "name": "eventcatalog",
-  "version": "0.0.1",
+  "version": "0.3.0",
   "private": true,
   "scripts": {
     "start": "eventcatalog start",