Skip to content

Commit e569e30

Browse files
committed
docs(readme): add advanced example
1 parent 9072489 commit e569e30

File tree

1 file changed

+27
-8
lines changed

1 file changed

+27
-8
lines changed

README.yaml

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
#
66

77
# Name of this project
8-
name: terraform-module-template
8+
name: terraform-aws-lambda-layer
99

1010
# Tags of this project
1111
tags:
@@ -20,16 +20,16 @@ categories:
2020
license: "APACHE2"
2121

2222
# Canonical GitHub repo
23-
github_repo: enter-at/terraform-module-template
23+
github_repo: enter-at/terraform-aws-lambda-layer
2424

2525
# Badges to display
2626
badges:
2727
- name: "Build Status"
28-
image: "https://github.com/enter-at/terraform-module-template/workflows/Terraform%20Lint/badge.svg"
29-
url: "https://github.com/enter-at/terraform-module-template/actions"
28+
image: "https://github.com/enter-at/terraform-aws-lambda-layer/workflows/Terraform%20Lint/badge.svg"
29+
url: "https://github.com/enter-at/terraform-aws-lambda-layer/actions"
3030
- name: "Latest Release"
31-
image: "https://img.shields.io/github/release/enter-at/terraform-module-template.svg"
32-
url: "https://github.com/enter-at/terraform-module-template/releases/latest"
31+
image: "https://img.shields.io/github/release/enter-at/terraform-aws-lambda-layer.svg"
32+
url: "https://github.com/enter-at/terraform-aws-lambda-layer/releases/latest"
3333
- name: "Semantic Release"
3434
image: "https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg"
3535
url: "https://github.com/semantic-release/semantic-release"
@@ -48,8 +48,27 @@ usage: |-
4848
### Simple Example
4949
5050
```hcl
51-
module "module" {
52-
source = "git::https://github.com/enter-at/terraform-module-template.git?ref=master"
51+
module "layer" {
52+
source = "git::https://github.com/enter-at/terraform-aws-lambda-layer.git?ref=master"
53+
layer_name = "dependencies"
54+
package_file = "../Pipfile"
55+
}
56+
```
57+
58+
### Advanced Example
59+
60+
```hcl
61+
module "layer" {
62+
source = "git::https://github.com/enter-at/terraform-aws-lambda-layer.git?ref=master"
63+
layer_name = "dependencies"
64+
source_dir = "../src/lib"
65+
source_type = "python"
66+
67+
rsync_pattern = [
68+
"--exclude=**tests**"
69+
"--exclude="**__pycache__**"
70+
"--include=*.py"
71+
]
5372
}
5473
```
5574

0 commit comments

Comments
 (0)