Rene/test

README.md

@@ -7,8 +7,6 @@
   <p align="center">
     ✨ <a href="https://terramate.io/docs/cli">https://terramate.io</a> ✨
     <br/>
-    Terramate an Infrastructure as Code (IaC) orchestration, collaboration, visibility and observability platform that <strong>unifies</strong>,
-    <strong>simplifies</strong>, and <strong>scales</strong> all your infrastructure code, tools, and workflows.
   </p>
 </p>
 <br/>
@@ -17,15 +15,18 @@
   <a href="https://terramate.io/discord" rel="nofollow"><img src="https://img.shields.io/discord/1088753599951151154?label=Discord&logo=discord&logoColor=white" alt="Discord Server"></a>
 </p>
 <p align="center">
-  <a href="https://terramate.io/docs">📖 Documentation</a> | <a href="https://terramate.io/docs/cli/getting-started">🚀 Getting Started</a> | <a href="https://play.terramate.io">💻 Playground</a> | <a href="https://jobs.ashbyhq.com/terramate" title="Terramate Job Board">🙌 Join Us</a>
+  <a href="https://terramate.io/docs">📖 Terramate Documentation</a> | <a href="https://terramate.io/docs/cli/getting-started">🚀 Getting Started</a> | <a href="https://play.terramate.io">💻 Playground</a> | <a href="https://jobs.ashbyhq.com/terramate" title="Terramate Job Board">🙌 Join Us</a>
 </p>
 
 <br>
 <br>
 
 ## Introduction
 
-This template repository provides a pre-configured Terramate project to get started with Terramate and Terraform on AWS using best practices.
+This template repository provides a pre-configured Terramate project to get started with Terramate and Terraform on AWS
+using best practices. It also comes with pre-configured GitOps workflows that run natively in GitHub Actions so that you
+can automate your Terraform in Pull Requests without requiring any additional tooling or infrastructure using the
+Terramate orchestration and change detection.
 
 ### Features
 
@@ -57,7 +58,19 @@ Terraform Remote State Storage and State Locking with AWS S3 and DynamoDB
 
 Pushes data to Terramate Cloud to enable observability, asset management, drift management and Slack notifications.
 
-#### Coming Soon
+#### How do you use this repository?
+
+##### Pre-requisites
+
+- Install asds 
+- Install asdf plugins `asdf add <plugin>`
+- Install asdf dependencies `asdf install`
+- Install pre-commit hooks `pre-commit install`
+
+- You need an AWS account (Configure your AWS credentials using one of the supported [authentication mechanisms](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication).
+)
+
+#### To Do
 
 - Policies with OPA and/or Sentinel
 - Implement checkov, trivy, terrascan

stacks/s3/demo-bucket/_backend.tf

@@ -0,0 +1,11 @@
+// TERRAMATE: GENERATED AUTOMATICALLY DO NOT EDIT
+
+terraform {
+  backend "s3" {
+    bucket         = "terramate-example-terraform-state-backend"
+    dynamodb_table = "terraform-lock"
+    encrypt        = true
+    key            = "terraform/stacks/by-id/0f87305d-e6d4-4087-8128-b33a6e80a8e8/terraform.tfstate"
+    region         = "us-east-1"
+  }
+}

stacks/s3/demo-bucket/_terraform.tf

@@ -0,0 +1,16 @@
+// TERRAMATE: GENERATED AUTOMATICALLY DO NOT EDIT
+
+terraform {
+  required_version = "1.7.1"
+}
+terraform {
+  required_providers {
+    aws = {
+      source  = "hashicorp/aws"
+      version = "~> 5.31"
+    }
+  }
+}
+provider "aws" {
+  region = "us-east-1"
+}

stacks/s3/demo-bucket/main.tf

@@ -0,0 +1,4 @@
+resource "aws_s3_bucket" "demo_bucket" {
+  bucket = "terramate-s3-demo"
+  acl    = "private"
+}

stacks/s3/demo-bucket/stack.tm.hcl

@@ -0,0 +1,5 @@
+stack {
+  name        = "demo-bucket"
+  description = "demo-bucket"
+  id          = "0f87305d-e6d4-4087-8128-b33a6e80a8e8"
+}