Skip to content

Commit a323ac2

Browse files
committed
Improve README
1 parent 0375710 commit a323ac2

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
1-
terraform-local-label
2-
===
1+
# terraform-local-label
32

43
Terraform module to provide consistent label names and tags for resources.
54

65
A single name format will not solve every use case, so multiple variants are returned and there is a few options to affect how they get build. The general name convention is `{organization}-{environment}-{name}-{attributes}`. `Name` is required, the other 3 can be turned on/off indivisually. The delimiter (`-`) can be changed
76

87
All devops-workflow module will eventually use this.
98

10-
*NOTE:* `local` refers to this using `locals` and does not create any resources. It just builds new variables.
9+
**NOTE:** `local` refers to this using [locals](https://www.terraform.io/docs/configuration/locals.html) and does not create any resources. It just builds new variables.
1110

1211
Terraform registry: https://registry.terraform.io/modules/devops-workflow/label/local
1312

14-
TODO: Add usage/examples
13+
## TODO: Add usage/examples

0 commit comments

Comments
 (0)