Skip to content

Commit

Permalink
terraform-docs: Update
Browse files Browse the repository at this point in the history
  • Loading branch information
ofhouse committed Jan 23, 2021
1 parent 61bb2fe commit 4389112
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,34 @@ A simple module to download files distributed via npm.

<!-- prettier-ignore-start -->
<!--- BEGIN_TF_DOCS --->
## Requirements

| Name | Version |
|------|---------|
| terraform | >= 0.13 |
| external | >= 1.2.0 |

## Providers

| Name | Version |
|------|---------|
| external | >= 1.2.0 |

## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| cdn\_provider\_url | The service that should be used for unpacking. jsdelivr or unpkg should work. | `string` | `"https://cdn.jsdelivr.net/npm/"` | no |
| module\_name | The name of the npm module. | `string` | n/a | yes |
| module\_version | If you want a specific version (or semver range) of the module define it here. | `string` | `""` | no |
| path\_to\_file | The path inside of the npm module to the file you want to download. | `string` | n/a | yes |
| use\_local | Fallback for using node.resolve for getting the module locally. Usually used for debug. | `bool` | `false` | no |

## Outputs

| Name | Description |
|------|-------------|
| abs\_path | The absolute path to the downloaded file on the local file system. |

<!--- END_TF_DOCS --->
<!-- prettier-ignore-end -->
Expand Down

0 comments on commit 4389112

Please sign in to comment.