Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
x-color committed May 16, 2021
1 parent c8b8749 commit 668ef2b
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# cfn-doc

This is a tool for generating document of CloudFormation template.
This is a tool for generating a document of CloudFormation template.

## Usage

```
cfn-doc is a tool for generating document of CloudFormation template.
cfn-doc is a tool for generating a document of CloudFormation template.
Usage:
cfn-doc [OPTION] <TEMPLATE FILE>
Expand All @@ -15,11 +15,19 @@ Options:
File name. Write to file instead of stdout
```

## Install

```sh
$ go install github.com/x-color/cfn-doc@latest
```

\*Required Go >= 1.16

## Sample

Generated document

```md
```markdown
# sample-template.yaml

## Description
Expand Down

0 comments on commit 668ef2b

Please sign in to comment.