example

.projenrc.ts

@@ -3,12 +3,15 @@ const project = new typescript.TypeScriptProject({
   defaultReleaseBranch: 'main',
   name: 'wing-cloud-platform',
   projenrcTs: true,
-  peerDeps: ["@winglang/sdk"],
-  description: "Wing Cloud Platform for testing all the way to production",
-  packageName: "@winglang/wing-platform",
+  peerDeps: ['@winglang/sdk'],
+  description: 'Wing Cloud Platform for testing all the way to production',
+  packageName: '@winglang/wing-platform',
   releaseToNpm: true,
   authorOrganization: true,
-  authorName: "Wing",
-  authorUrl: "https://winglang.io",
+  authorName: 'Wing',
+  authorUrl: 'https://winglang.io',
+  gitignore: [
+    "**/target"
+  ],
 });
 project.synth();

README.md

@@ -1,6 +1,21 @@
 # Wing Cloud Platform
 
-## Setup
+> Nb: This is WIP and has unstable APIs. All of it might and likely will change without prior notice
+
+## Usage
+
+```
+npm install @winglang/wing-cloud-platform
+```
+
+```
+export WING_ENV=<test|dev|production>
+wing compile -t tf-aws -t @winglang/wing-cloud-platform main.w
+```
+
+if `WING_ENV` is not present it'll will default to `dev`.
+
+## Dev
 
 ```
 yarn --version