feat: updated README

README.md

@@ -1,34 +1,19 @@
 # terraform-google-artifact-registry
 
-## Description
-### Tagline
-This is an auto-generated module.
-
-### Detailed
-This module was generated from [terraform-google-module-template](https://github.com/terraform-google-modules/terraform-google-module-template/), which by default generates a module that simply creates a GCS bucket. As the module develops, this README should be updated.
+The Terraform module handles the creation of repositories in Artifact Registry on Google Cloud.
 
 The resources/services/activations/deletions that this module will create/trigger are:
 
-- Create a GCS bucket with the provided name
-
-### PreDeploy
-To deploy this blueprint you must have an active billing account and billing permissions.
-
-## Architecture
-![alt text for diagram](https://www.link-to-architecture-diagram.com)
-1. Architecture description step no. 1
-2. Architecture description step no. 2
-3. Architecture description step no. N
-
-## Documentation
-- [Hosting a Static Website](https://cloud.google.com/storage/docs/hosting-static-website)
+- Different repositories in Artifact Registry
+    - docker, apt, yum, go, pypi, npm, maven
+- Provide Artifact Registry Reader or Writer roles to the users and service accounts
 
-## Deployment Duration
-Configuration: X mins
-Deployment: Y mins
+## Assumptions and prerequisites
+This module assumes that below mentioned prerequisites are in place before consuming the module.
 
-## Cost
-[Blueprint cost details](https://cloud.google.com/products/calculator?id=02fb0c45-cc29-4567-8cc6-f72ac9024add)
+- To deploy this blueprint you must have an active billing account and billing permissions.
+- APIs are enabled
+- Permissions are available
 
 ## Usage
 
@@ -39,8 +24,11 @@ module "artifact_registry" {
   source  = "terraform-google-modules/artifact-registry/google"
   version = "~> 0.1"
 
-  project_id  = "<PROJECT ID>"
-  bucket_name = "gcs-test-bucket"
+  # Required variables
+  project_id    = "<PROJECT ID>"
+  location      = "<LOCATION>"
+  format        = "<REPO_FORMAT>"
+  repository_id = "<REPO_NAME>"
 }
 ```
 
@@ -89,34 +77,33 @@ These sections describe requirements for using this module.
 
 The following dependencies must be available:
 
-- [Terraform][terraform] v0.13
-- [Terraform Provider for GCP][terraform-provider-gcp] plugin v3.0
+- [Terraform][terraform] v0.13+
+- [Terraform Provider for GCP][terraform-provider-gcp] plugin v3.0+
 
 ### Service Account
 
-A service account with the following roles must be used to provision
-the resources of this module:
+A service account with the following roles must be used to provision the resources of this module:
 
-- Storage Admin: `roles/storage.admin`
+- Artifact Registry Admin: `roles/artifactregistry.admin`
+- Secret Manager Admin: `roles/secretmanager.admin`
+- Context Manager Admin: `roles/contextmanager.admin`
 
-The [Project Factory module][project-factory-module] and the
-[IAM module][iam-module] may be used in combination to provision a
-service account with the necessary roles applied.
+The [Project Factory module][project-factory-module] and the [IAM module][iam-module] may be used in combination to provision a service account with the necessary roles applied.
 
 ### APIs
 
 A project with the following APIs enabled must be used to host the
 resources of this module:
 
-- Google Cloud Storage JSON API: `storage-api.googleapis.com`
+- Artifact Registry JSON API: `artifactregistry.googleapis.com`
+- Secret Manager JSON API: `secretmanager.googleapis.com`
+- Context Manager JSON API: `contextmanager.googleapis.com`
 
-The [Project Factory module][project-factory-module] can be used to
-provision a project with the necessary APIs enabled.
+The [Project Factory module][project-factory-module] can be used to provision a project with the necessary APIs enabled.
 
 ## Contributing
 
-Refer to the [contribution guidelines](./CONTRIBUTING.md) for
-information on contributing to this module.
+Refer to the [contribution guidelines](./CONTRIBUTING.md) for information on contributing to this module.
 
 [iam-module]: https://registry.terraform.io/modules/terraform-google-modules/iam/google
 [project-factory-module]: https://registry.terraform.io/modules/terraform-google-modules/project-factory/google