Skip to content

Commit

Permalink
doc: update install section
Browse files Browse the repository at this point in the history
  • Loading branch information
takaishi committed Aug 1, 2023
1 parent 904cacc commit 465d500
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
terraform-j2md
===
# terraform-j2md

![Go](https://github.com/reproio/terraform-j2md/workflows/Go/badge.svg)
![goreleaser](https://github.com/reproio/terraform-j2md/workflows/goreleaser/badge.svg)

Expand All @@ -11,18 +11,27 @@ _terraform-j2md_ is simple conversion tool, from Terraform JSON to Markdown text

Output texts may be useful as pull-request comments, and so on.

## How to use
## Install

```
% go install github.com/reproio/terraform-j2md/cmd/terraform-j2md@latest
```

### GitHub Actions

### Installation
(TBD)
```yaml
- uses: reproio/terraform-j2md@main
with:
version: v0.0.5 # or latest
```
### Usage
## Usage
_terraform-j2md_ reads only standard input, write only standard output.
```
terraform-j2md < [input file] > [output file]
```

### Example
## Example
````sh
$ terraform init
$ terraform plan -out plan.tfplan
Expand Down

0 comments on commit 465d500

Please sign in to comment.