Skip to content

Commit

Permalink
docs: standardize README documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
arnol377 committed Mar 26, 2025
1 parent 4e35b43 commit 2e56266
Showing 1 changed file with 48 additions and 1 deletion.
49 changes: 48 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 2e56266

Please sign in to comment.