Skip to content

Commit

Permalink
docs: touch up docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sgtoj committed Jul 11, 2023
1 parent 09249ab commit df9b865
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 13 deletions.
11 changes: 3 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,15 @@ following tools:

```bash
git clone https://github.com/sgtoj/terraform-docker-artifact-packager.git
code terraform-aws-cognito-custom-message-sender
```

2. Open the repository in Visual Studio Code:

```bash
code terraform-docker-artifact-packager
```

3. When prompted to "Reopen in Container", click "Reopen in Container". This
2. When prompted to "Reopen in Container", click "Reopen in Container". This
will start building the Docker image for the development container. If you're
not prompted, you can open the Command Palette (F1 or Ctrl+Shift+P), and run
the "Remote-Containers: Reopen Folder in Container" command.
4. After the development container is built and started, you can use the
3. After the development container is built and started, you can use the
Terminal in Visual Studio Code to interact with the container. All commands
you run in the Terminal will be executed inside the container.
Expand Down
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Terraform Module: AWS Cognito Custom SMS Sender
# Terraform Module: AWS Cognito Custom Message Sender

This Terraform module deploys a AWS Lambda function to serve as a custom SMS
sender for AWS Cognito. The module uses Open Policy Agent (OPA) policies to
Expand All @@ -20,7 +20,8 @@ located within its directory.

```hcl
module "cognito_custom_sms_sender" {
source = "sgtoj/cognito-custom-message-sender/aws"
source = "sgtoj/cognito-custom-message-sender/aws"
version = "1.x.x"
sms_sender_enabled = true
sms_sender_policy_content = "<OPA policy content>"
Expand Down Expand Up @@ -62,6 +63,6 @@ for more details on these variables.

## Contributing

We welcome contributions to the Terraform AWS Cognito Custom SMS Sender Module!
For information on setting up a development environment and how to make a
contribution, see [CONTRIBUTING.md](./CONTRIBUTING.md).
We welcome contributions to the project! For information on setting up a
development environment and how to make contribution, see [CONTRIBUTING](./CONTRIBUTING.md)
documentation.

0 comments on commit df9b865

Please sign in to comment.