feat: updated example path and readme parameters (#21)

* feat: updated example path and readme parameters

* feat- Updated Path for Ignore File

---------

Co-authored-by: Vishwajit Nagulkar <119565952+VishwajitNagulkar@users.noreply.github.com>

.github/dependabot.yml

@@ -15,7 +15,7 @@ updates:
     reviewers:
       - "approvers"
   - package-ecosystem: "terraform" # See documentation for possible values
-    directory: "_example/" # Location of package manifests
+    directory: "examples/" # Location of package manifests
     schedule:
       interval: "weekly"
     # Add assignees

.github/workflows/automerge.yml

@@ -8,5 +8,5 @@ jobs:
     secrets:
       GITHUB: ${{ secrets.GITHUB }}
     with:
-      tfcheck: '_example / Check code format'
+      tfcheck: 'examples / Check code format'
 ...

.github/workflows/readme.yml

@@ -1,14 +1,15 @@
-name: 'Create README.md file'
+name: Readme Workflow
 on:
   push:
     branches:
       - master
     paths-ignore:
       - 'README.md'
-
+      - 'docs/**'
+  workflow_dispatch:
 jobs:
-  readme-create:
-    uses: clouddrove/github-shared-workflows/.github/workflows/readme.yml@1.2.1
+  README:
+    uses: clouddrove/github-shared-workflows/.github/workflows/readme.yml@1.2.4
     secrets:
-      TOKEN: ${{ secrets.GITHUB }}
-      SLACK_WEBHOOK_TERRAFORM: ${{ secrets.SLACK_WEBHOOK_TERRAFORM }}
+      TOKEN : ${{ secrets.GITHUB }}
+      SLACK_WEBHOOK_TERRAFORM: ${{ secrets.SLACK_WEBHOOK_TERRAFORM }}

.github/workflows/tf-checks.yml

@@ -8,4 +8,4 @@ jobs:
   _example:
     uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@1.0.10
     with:
-      working_directory: './_example/'
+      working_directory: './examples/'

README.yaml

@@ -15,27 +15,42 @@ github_repo: clouddrove/terraform-aws-cognito
 
 # Badges to display
 badges:
-  - name: "Terraform"
-    image: "https://img.shields.io/badge/Terraform-v1.1.7-green"
-    url: "https://www.terraform.io"
+  - name: "Latest Release"
+    image: "https://img.shields.io/github/release/clouddrove//terraform-aws-cognito.svg"
+    url: "https://github.com/clouddrove//terraform-aws-cognito/releases/latest"
+  - name: "tfsec"
+    image: "https://github.com/clouddrove//terraform-aws-cognito/actions/workflows/tfsec.yml/badge.svg"
+    url: "https://github.com/clouddrove//terraform-aws-cognito/actions/workflows/tfsec.yml"
   - name: "Licence"
     image: "https://img.shields.io/badge/License-APACHE-blue.svg"
     url: "LICENSE.md"
-  - name: "tfsec"
-    image: "https://github.com/clouddrove/terraform-aws-cognito/actions/workflows/tfsec.yml/badge.svg"
-    url: "https://github.com/clouddrove/terraform-aws-cognito/actions/workflows/tfsec.yml"
-  - name: "static-checks"
-    image: "https://github.com/clouddrove/terraform-aws-cognito/actions/workflows/terraform.yml/badge.svg"
-    url: "https://github.com/clouddrove/terraform-aws-cognito/actions/workflows/terraform.yml"
+  - name: "Changelog"
+    image: "https://img.shields.io/badge/Changelog-blue"
+    url: "CHANGELOG.md"
+
+prerequesties:
+  - name: Terraform
+    url: https://learn.hashicorp.com/terraform/getting-started/install.html
+    version: ">= 1.6.6"
+
+providers:
+  - name: aws
+    url: https://aws.amazon.com/
+    version: ">= 5.31.0"
+
+module_dependencies:
+  - name: Labels Module
+    url: https://github.com/clouddrove/terraform-aws-labels
+    description: Provides resource tagging.
+
+  - name: IAM Role Module
+    url: https://github.com/clouddrove/terraform-aws-iam-role
+    description: Provides resource iam-role.
 
 #  description of this project
 description: |-
   Terraform module to create an Cognito resource on AWS.
 
-# extra content
-include:
-  - "terraform.md"
-
 # How to use this project
 # yamllint disable rule:line-length
 usage: |-