Skip to content

Commit ed237fe

Browse files
committed
chore: update README.md
1 parent 26fbb95 commit ed237fe

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
**
1919
** This file was automatically generated by the `cloudposse/build-harness`.
2020
** 1) Make all changes to `README.yaml`
21-
** 2) Run `make init` (you only need to do this once)
22-
** 3) Run`make readme` to rebuild this file.
21+
** 2) Install [atmos](https://atmos.tools/install/) (you only need to do this once)
22+
** 3) Run`atmos readme` to rebuild this file.
2323
**
2424
** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.)
2525
**
@@ -105,8 +105,22 @@ steps:
105105

106106

107107

108+
## Inputs
109+
<!-- markdownlint-disable -->
110+
| Name | Description | Default | Required |
111+
|------|-------------|---------|----------|
112+
| atmos-version | Version Spec of the version to use. Examples: 1.x, 10.15.1, >=10.15.0. | latest | false |
113+
| install-wrapper | Flag to indicate if the wrapper script will be installed to wrap subsequent calls of the `atmos` binary and expose its STDOUT, STDERR, and exit code as outputs named `stdout`, `stderr`, and `exitcode` respectively. Defaults to `true`. | true | false |
114+
| token | Used to pull atmos distributions from Cloud Posse's GitHub repository. Since there's a default, this is typically not supplied by the user. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting. | ${{ github.server\_url == 'https://github.com' && github.token \|\| '' }} | false |
115+
<!-- markdownlint-restore -->
108116

109117

118+
## Outputs
119+
<!-- markdownlint-disable -->
120+
| Name | Description |
121+
|------|-------------|
122+
| atmos-version | The installed atmos version. |
123+
<!-- markdownlint-restore -->
110124

111125

112126

0 commit comments

Comments
 (0)