Fix published README and badges

pwrdrvr · Jan 1, 2023 · 1942859 · 1942859
1 parent 90a4dfa
commit 1942859
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 21 deletions.
diff --git a/README.md b/README.md
diff --git a/README.md b/README.md
@@ -0,0 +1 @@
+packages/cdk-construct/README.md
diff --git a/packages/cdk-construct/README.md b/packages/cdk-construct/README.md
@@ -1,5 +1,20 @@
-![Build/Deploy CI](https://github.com/pwrdrvr/microapps-app-nextjs-demo/actions/workflows/ci.yml/badge.svg) ![Main Build](https://github.com/pwrdrvr/microapps-app-nextjs-demo/actions/workflows/main-build.yml/badge.svg) ![Deploy](https://github.com/pwrdrvr/microapps-app-nextjs-demo/actions/workflows/deploy.yml/badge.svg)
+![Build/Deploy CI](https://github.com/pwrdrvr/microapps-app-nextjs-demo/actions/workflows/ci.yml/badge.svg) ![JSII](https://github.com/pwrdrvr/microapps-app-nextjs-demo/actions/workflows/jsii.yml/badge.svg) ![Release](https://github.com/pwrdrvr/microapps-app-nextjs-demo/actions/workflows/release.yml/badge.svg)
 
 # Overview
 
 This is the Release Console for the MicroApps framework.
+
+# Development
+
+- `nvm use`
+- For Mac
+  - Install Xcode
+  - `xcode-select --install`
+  - `brew install vips`
+- `npm i`
+- `npm run dev`
+- Open in browser: `http://localhost:3000/nextjs-demo/0.0.0`
+
+# Publish New Version of Microapp
+
+See GitHub Actions workflows for example commands.