DEVOPS-95 updated the readme properly

Author: githubofkrishnadhas

README.md

@@ -1,7 +1,62 @@
 # azure-create-app-registrations-using-terraform
 Create app registrations in Azure using terraform and github workflow
 
+# How code works
 
-#References
+* This repo uses terraform to create app registration and service principal in Azure.
+
+# parameters used
+
+| input name | description | type | mandatory |
+|------------|------------|-----|-------------|
+| app_registration_name | Azure App registration name | string | :heavy_check_mark: |
+| app_registration_owner | App registration owners names | string | :heavy_check_mark: |
+| app_registration_description | App registration description | string | |
+
+# Terraform commands and How to run the code locally
+
+1. Clone the repo and switch to the folder
+2. cd azure-create-app-registrations-using-terraform
+3. Then run `terraform init`
+4. run `terraform validate`
+5. then `terraform plan`
+6. provide the values when popped up
+7. then `terraform apply` and provide `yes` as confirmation
+
+## Conditions
+
+* Azure active directory user should have a proper mail id available
+
+# How to run as a github workflow
+
+1. Go to your cloned repo and then to actions tab
+
+2. Choose the workflow `azure-create-app-registrations-using-terraform.yaml` on left side
 
-[azuread_application_password](https://registry.terraform.io/providers/hashicorp/azuread/latest/docs/resources/application_password)
+3. Next click on `Run Workflow` on right side top and enter the input parameters required
+
+4. Click on `Run Workflow` (green one)
+
+5. After the job is completed, The app registration and sp will be created with owners
+
+# Credentials needed
+
+**Authentication to Azure is done using service principal**
+
+```
+env:
+    ARM_CLIENT_ID: ${{ secrets.APP_ID }}
+    ARM_CLIENT_SECRET: ${{ secrets.APP_SECRET }}
+    ARM_TENANT_ID: ${{ secrets.TENANT_ID }}
+    ARM_SUBSCRIPTION_ID: ${{ secrets.SUBSCRIPTION_ID }}
+```
+
+`ARM_CLIENT_ID`, `ARM_CLIENT_SECRET`, `ARM_TENANT_ID`, `ARM_SUBSCRIPTION_ID` are required Environment variables.
+
+I used GitHub secrets on the workflow for authentication. 
+
+
+#References
+* [using-secrets-in-github-actions](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions)
+* [azuread_application_password](https://registry.terraform.io/providers/hashicorp/azuread/latest/docs/resources/application_password)
+* [azuread_service_principal](https://registry.terraform.io/providers/hashicorp/azuread/latest/docs/resources/service_principal)

variable.tf

@@ -11,5 +11,6 @@ variable "app_registration_owners" {
 
 variable "app_registration_description" {
   type    = string
+  description = "Description for you app"
   default = "Azure App registration created using terraform"
 }