Skip to content

Commit

Permalink
chore: add CDK example to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mirrajabi committed Dec 2, 2023
1 parent a172ccb commit 2481a77
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Expand Up @@ -61,6 +61,15 @@ import { renderTemplate } from 'cf-render';
...
```

## How to use it with CDK

CDK generates CloudFormation templates in the `cdk.out` directory when synthesizing the stacks. You can use this tool to render the generated templates. You can also ask CDK to just synthesize your stacks and not deploy them.

```bash
cdk synth
cf-render -i cdk.out/MyStack.template.json -o MyStack.png
```

## Roadmap

- [x] Put it out there!
Expand Down

0 comments on commit 2481a77

Please sign in to comment.