Merge pull request #4 from anandg112/chore/readme-updates-and-add-kic…

…kstart

feat: update readme and add kickstart script

kickstart.sh

@@ -0,0 +1,19 @@
+#!/bin/sh -ex
+
+terraform init -backend=true \
+-backend-config=bucket\=tf-state-anand \
+-backend-config=key\=state \
+-backend-config=region\=us-east-1 \
+-input=false \
+
+NOW=$date
+
+if [ $ACTION == "deploy" ]
+then
+    echo "Deployment started at $NOW" 
+    terraform apply -auto-approve
+elif [ $ACTION == "destroy" ]
+then
+    echo "Teardown started at $NOW"
+    terraform destroy -auto-approve
+fi

readme.md

@@ -8,7 +8,8 @@ This project sets up Postgres 9.6 on AWS and supports encryption at rest.
 
 #### Set these variables in your `.envrc` file
 
-```TF_VAR_user=anand
+```bash
+TF_VAR_user=anand
 TF_VAR_owner=anand
 TF_VAR_environment=dev
 TF_VAR_dbname=postgres
@@ -21,14 +22,22 @@ ACTION=deploy
 
 ### Building the docker image
 
-`docker build -f ./provisioner/Dockerfile -t rds-provisioner .`
+```bash
+docker build -f ./provisioner/Dockerfile -t rds-provisioner .
+```
 
 ### Running the provisioner for Postgres on AWS
 
-`docker run --env-file .envrc rds-provisioner`
+```bash
+docker run --env-file .envrc rds-provisioner
+```
 
 ---
 
+### Release
+
+This project uses GitHub Actions to release new versions of the terraform module through semantic-release NPM package. GitHub Actions also performs a `terraform plan` `terraform fmt` to ensure module is tested and formatted properly.
+
 ### Still to do
 
 #### ~~Add CI for checking code defects~~ - Done