docs: simplify usage section, add branch comment in examples, add ver…

…sion pinning

README.md

@@ -16,22 +16,26 @@ The following [reusable workflows](https://docs.github.com/en/actions/using-work
 
 To use these workflows in your project, copy files from the folders listed below, and paste them in the `.github/workflows/` folder in your own repo.
 
-- `global`: `release`, `semantic-check`
-  - Sets up Release Please and semantic-check, for standardized commits and automated releases
-- `terraform`: `terraform-quality`, `terraform-docs`
-  - Sets up automated Terraform code quality and security checks, as well as `terraform-docs` for automated documentation updating
+- [`global`](global/): for all your projects
+- [`terraform`](terraform/): useful for Terraform modules and starters
 
 Your repo should have the following structure:
 
 ```
-.github
-| workflows
-| | terraform-quality.yml
-| | terraform-docs.yml
-| | ... (other workflows)
-main.tf
-README.md
-... (other files)
+.
+├── .github
+│   ├── CODEOWNERS
+│   └── workflows
+│       ├── release.yml
+│       ├── semantic-check.yml
+│       ├── terraform-docs.yml
+│       └── terraform-quality.yml
+├── .gitignore
+├── LICENSE
+├── main.tf
+├── README.md
+├── renovate.json
+└── ... (other files)
 ```
 
 ## Workflow Designs

global/release.yml

@@ -1,8 +1,9 @@
 on:
   push:
     branches:
-      - main
+      - main # your trunk branch
+
 name: release
 jobs:
   release:
-    uses: padok-team/github-workflows/.github/workflows/release.yml@main
+    uses: padok-team/github-workflows/.github/workflows/release.yml@v1

global/semantic-check.yml

@@ -1,8 +1,9 @@
 on:
   pull_request:
     branches:
-      - main
+      - main # your trunk branch
+
 name: semantic-check
 jobs:
   semantic-check:
-    uses: padok-team/github-workflows/.github/workflows/semantic-check.yml@main
+    uses: padok-team/github-workflows/.github/workflows/semantic-check.yml@v1

terraform/terraform-docs.yml

@@ -1,8 +1,9 @@
 on:
   push:
     branches:
-      - main
+      - main # your trunk branch
+
 name: terraform-docs
 jobs:
   terraform-docs:
-    uses: padok-team/github-workflows/.github/workflows/terraform-docs.yml@main
+    uses: padok-team/github-workflows/.github/workflows/terraform-docs.yml@v1

terraform/terraform-quality.yml

@@ -1,8 +1,9 @@
 on:
   pull_request:
     branches:
-      - main
+      - main # your trunk branch
+
 name: terraform-quality
 jobs:
   terraform-quality:
-    uses: padok-team/github-workflows/.github/workflows/terraform-quality.yml@main
+    uses: padok-team/github-workflows/.github/workflows/terraform-quality.yml@v1