Skip to content

Commit

Permalink
chore: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mirrajabi committed Dec 2, 2023
1 parent e170547 commit a172ccb
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
@@ -1,13 +1,15 @@
# CloudFormation Template Renderer

![npm](https://img.shields.io/npm/v/cf-render)

This is a simple tool that leverages AWS Application Composer's renderer to render CloudFormation templates. Since **CDK** also generates CloudFormation templates, this tool can be used to render the stacks created by CDK projects as well.

**Beta notice**: This tool is currently in beta. Please report any issues you encounter. also read the [Good to know](#good-to-know) section.

## Example output

Below image is the output of [this template](https://github.com/awslabs/aws-cloudformation-templates/blob/master/community/solutions/StaticWebSiteWithPipeline/stacks/pipeline.json).
![Example output](./assets/example.png)
![Example output](https://github.com/mirrajabi/cf-render/blob/main/assets/example.png)

## Installation

Expand Down

0 comments on commit a172ccb

Please sign in to comment.