Skip to content

Commit dd0d193

Browse files
committed
chore: Update README
1 parent a5b1ab5 commit dd0d193

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ A module to create application secrets stored in [AWS Secrets Manager](https://a
1414

1515
## Prerequisites
1616

17-
* [Terraform](https://www.terraform.io/downloads.html) (version `0.12.9` or higher)
17+
* [Terraform](https://www.terraform.io/downloads.html) (version `0.12.20` or higher)
1818
* [AWS provider](https://www.terraform.io/docs/providers/aws/) (version `2.60` or higher)
1919

2020
## Example usage
2121

2222
```hcl
2323
module "secrets" {
24-
source = "git::ssh://git@github.com/scribdterraform-aws-app-secrets.git?ref=main"
24+
source = "git::ssh://git@github.com/scribd/terraform-aws-app-secrets.git?ref=main"
2525
2626
app_name = "go-chassis"
2727
secrets = {
@@ -42,12 +42,10 @@ module "secrets" {
4242
}
4343
```
4444

45-
>>>
46-
⚠️ **IMPORTANT NOTES**
47-
48-
* Please don't use `ref=main` in your production code. Please refer to a release tag explicitly.
49-
* Please don't put actual secret values to the terraform code except for the static configuration values (for instance, the static ports). Use any dummy values to provision the secrets. The actual values have to be set manually via [AWS Web Console](https://aws.amazon.com/secrets-manager/) or [AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/secretsmanager/index.html) afterwards.
50-
>>>
45+
> ⚠️ **IMPORTANT NOTES**
46+
>
47+
> * Please don't use `ref=main` in your production code. Please refer to a release tag explicitly.
48+
> * Please don't put actual secret values to the terraform code except for the static configuration values (for instance, the static ports). Use any dummy values to provision the secrets. The actual values have to be set manually via [AWS Web Console](https://aws.amazon.com/secrets-manager/) or [AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/secretsmanager/index.html) afterwards.
5149
5250
## Inputs
5351

@@ -84,4 +82,4 @@ The `semantic-release` configuration is in [`.releaserc.yml`](https://github.com
8482

8583
## Maintainers
8684

87-
Made with ❤️ by the Service Foundations team.
85+
Made with ❤️ by the Service Foundations team.

0 commit comments

Comments
 (0)