From 2e56266fd37d0a994d9a495a2f836e2849d5f39f Mon Sep 17 00:00:00 2001 From: arnol377 Date: Wed, 26 Mar 2025 18:43:40 -0400 Subject: [PATCH] docs: standardize README documentation --- README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 48 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5ab8f0b..dfb9b4d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,49 @@ # terraform-init -Composite Action for Terraform-Apply + +## Description + +A GitHub composite action that... + +## Features + +- Feature 1 +- Feature 2 + +## Inputs + +| Name | Description | Required | Default | +|------|-------------|----------|----------| +| `terraform_version` | No description provided | True | `N/A` | +| `terraform_api` | No description provided | False | `N/A` | +| `workspace` | No description provided | False | `N/A` | +| `varfile` | No description provided | False | `N/A` | +| `init_args` | No description provided | False | `N/A` | +| `commit_sha` | No description provided | False | `N/A` | +| `cache_bucket` | No description provided | False | `csvd-dev-ew-github-actions` | +| `backend_config` | No description provided | False | `''` | + +## Outputs + +| Name | Description | +|------|-------------| +| `commit_sha` | No description provided | +| `description` | No description provided | +| `value` | No description provided | +| `s3_upload_path` | No description provided | + +## Usage Examples + +```yaml +jobs: + example: + runs-on: ubuntu-latest + steps: + - uses: CSVD/terraform-init@v1 + with: + # Add required inputs here +``` + +## Requirements + +- List requirements here +