diff --git a/README.md b/README.md index 378f1db..f8ede29 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,34 @@ A simple module to download files distributed via npm. +## 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. |