Convert help to README

This commit is contained in:
Khue Doan 2021-08-04 01:14:55 +07:00
parent ae7e1de99e
commit bf97010ff8
2 changed files with 33 additions and 24 deletions

33
infra/cdk/README.md Normal file
View File

@ -0,0 +1,33 @@
# Terraform CDK
## Usage
Compile:
```sh
go build # Builds your go project
```
Synthesize:
```sh
cdktf synth [stack] # Synthesize Terraform resources to cdktf.out/
```
Diff:
```sh
cdktf diff [stack] # Perform a diff (terraform plan) for the given stack
```
Deploy:
```sh
cdktf deploy [stack] # Deploy the given stack
```
Destroy:
```sh
cdktf destroy [stack] # Destroy the given stack
```

View File

@ -1,24 +0,0 @@
========================================================================================================
Your cdktf go project is ready!
cat help Prints this message
Compile:
go build Builds your go project
Synthesize:
cdktf synth [stack] Synthesize Terraform resources to cdktf.out/
Diff:
cdktf diff [stack] Perform a diff (terraform plan) for the given stack
Deploy:
cdktf deploy [stack] Deploy the given stack
Destroy:
cdktf destroy [stack] Destroy the given stack
Learn more about using modules and providers https://cdk.tf/modules-and-providers
========================================================================================================