docs: update usages and inputs sections

cruxstack · Jul 31, 2023 · 8dc3bb7 · 8dc3bb7
1 parent 3661487
commit 8dc3bb7
Showing 1 changed file with 6 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -21,21 +21,21 @@ be determined in advance.
 
 ```hcl
 module "s3_zip_uploader" {
-  source  = "sgtoj/s3-zip-uploader/aws"
+  source  = "cruxstack/s3-zip-uploader/aws"
   version = "x.x.x"
 
   artifact_src_local_path = "/path/to/yourfile.zip"
   artifact_dst_bucket_arn = "arn:aws:s3:::yourdestinationbucket"
 }
 ```
 
-## Requirements
-
-- Terraform 0.13 or newer
-- AWS provider 4.0 or newer
-
 ## Inputs
 
+This module uses the `cloudposse/label/null` module for naming and tagging
+resources. As such, it also includes a `context.tf` file with additional
+optional variables you can set. Refer to the [`cloudposse/label` documentation](https://registry.terraform.io/modules/cloudposse/label/null/latest)
+for more details on these variables.
+
 | Name                       | Description                                                                                                                                                         | Type   | Default                     | Required |
 |----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|-----------------------------|----------|
 | `artifact_src_bucket_arn`  | The ARN of the S3 bucket where the source artifact zip file will be stored. If not provided, the source bucket is assumed to be the same as the destination bucket. | string | `""`                        | No       |
@@ -44,13 +44,6 @@ module "s3_zip_uploader" {
 | `artifact_dst_bucket_arn`  | The ARN of the destination S3 bucket where the contents of the zip file will be uploaded.                                                                           | string | N/A                         | Yes      |
 | `artifact_dst_bucket_path` | The path within the destination S3 bucket where the contents of the zip file will be uploaded.                                                                      | string | `"/"`                       | No       |
 
-### Note
-
-This module uses the `cloudposse/label/null` module for naming and tagging
-resources. As such, it also includes a `context.tf` file with additional
-optional variables you can set. Refer to the [`cloudposse/label` documentation](https://registry.terraform.io/modules/cloudposse/label/null/latest)
-for more details on these variables.
-
 ## Outputs
 
 _This module does not currently provide any outputs._