Merge pull request #14 from oracle-devrel/develop

Develop

Author: xs2suruchi

README.md

@@ -4,6 +4,7 @@
 [![License: UPL](https://img.shields.io/badge/license-UPL-green)](https://img.shields.io/badge/license-UPL-green) [![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=oracle-devrel_cd3-automation-toolkit)](https://sonarcloud.io/dashboard?id=oracle-devrel_cd3-automation-toolkit)
 
 ## Introduction
+CD3 stands for Cloud Deployment Design Deliverable.
 The CD3 Automation toolkit has been developed to help in automating the OCI resource object management. 
 <br>
 It reads input data in the form of CD3 Excel sheets and generates the terraform files instead of handling the task through the OCI console manually. This simplifies the management of the company's infrastructure as code.
@@ -14,28 +15,37 @@ It reads input data in the form of CD3 Excel sheets and generates the terraform
 `To ease the execution of toolkit, we have provided the steps to build an image which encloses the code base and its package dependencies. Follow the steps provided below to clone the repo and build the image.`
 <br><br>
 
-#### OCI Services Supported by CD3
+#### OCI Services Currently Supported by CD3
 <img width="748" alt="Screenshot 2022-12-30 at 1 05 59 PM" src="https://user-images.githubusercontent.com/103475219/210046038-91acacfd-5d65-4bc3-a1a8-90d425d2e3d3.png">
 
 
 ## Getting Started
 
+### Pre-requisites
+* Git
+* Any docker cli compatible platform such as Docker or Rancher.
+* OCI Tenancy Access Requirement - 
+Appropriate IAM policies must be in place for each of the resources that the user may try to create.
+Minimum requirement for the user to get started is to have the ability to read to the tenancy.
+
 ### To clone the repo
 * Open your terminal and change the directory to the one where you want to download the git repo.
 * Run the git clone command as shown below:
        git clone https://github.com/oracle-devrel/cd3-automation-toolkit
 * Once the cloning command completes successfully, the repo will replicate to the local directory. 
-* Run command "git pull" or "git pull <repo_web_url> main" to replicate any new changes to the repo upon a new release
 
 ### To build an image
 
 * Change directory to cd3-automation-toolkit(i.e. the cloned repo in your local).
 * Run docker build -t cd3toolkit:${image_tag} -f Dockerfile --pull --no-cache .
-<br><br>
-### To save the image (Optional)
 
+<b>Note</b> : <i>${image_tag} should be replaced with suitable tag as per your requirements/standards.</i>
+<br>
+
+### To save the image (Optional)
 * Run docker save cd3toolkit:${image_tag} | gzip > cd3toolkit_${image_tag}.tar.gz
-<br><br>
+
+
 ### To run the CD3 container and exec into it
 * Run docker run -it -d -v <path_in_local_system_where_the_files_must_be_generated>:/cd3user/tenancies <image_name>:<image_tag>
 * Run docker ps
@@ -47,9 +57,7 @@ https://github.com/oracle-devrel/cd3-automation-toolkit/blob/develop/cd3_automat
 <br><br>
 Please download the document from Github.
 <br>
-Note : ${image_tag} should be replaced with suitable tag as per your requirements/standards.
-
-       The above steps have been tested on Windows (Git Bash) and MacOS.
+<b>Note</b> : <i>The above steps have been tested on Windows (Git Bash) and MacOS.</i>
 
 ## Contributing
 This project is open source.  Please submit your contributions by forking this repository and submitting a pull request!  Oracle appreciates any contributions that are made by the open source community.