From 8ba6062fc9436e2a83af0723dbde0ed93a968507 Mon Sep 17 00:00:00 2001
From: Muhammad Salman <m.salman899@gmail.com>
Date: Sat, 23 Jul 2022 19:28:57 +0200
Subject: [PATCH] update Readme to include data source example

---
 README.md | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 66 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index d0c8777d0a3f..3946107e8662 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,69 @@
-<a href="https://terraform.io">
-    <img src=".github/terraform_logo.svg" alt="Terraform logo" title="Terraform" align="right" height="50" />
-</a>
+# Fork of Terraform Provider for AWS
+
+Implementing AWS terraform datasources that are currently not available in official AWS terraform Provider
+
+## Available DataSources
+
+### RDS
+
+- aws_db_instances (filter RDS instances based on provided resource tags)
+- aws_rds_clusters (filter RDS clusters based on provided resource tags)
+
+## Usage
+
+```hcl
+terraform {
+  required_providers {
+    awscust = {
+      version = "5.1.2"
+      source  = "msalman899/aws"
+    }
+  }
+}
+
+provider "awscust" {
+    region = "eu-west-1"
+    profile = "my-account"
+}
+
+#---------------------------
+# aws_db_instances
+#---------------------------
+
+# Below data source will return all RDS instances that satisfy given tag's key-value criteria
+
+data "aws_db_instances" "database" {
+  provider = awscust
+  filter {
+    name = "team"
+    values = ["value1","value2","value3"]
+  }
+
+  filter {
+    name = "tribe"
+    values = ["value1","value2"]
+  }
+  
+  filter {
+    name = "tagkey"
+    values = ["tagvalue"]
+  }
+}
+
+#---------------------------
+# aws_rds_clusters
+#---------------------------
+
+# Below data source will return all RDS clusters that satisfy given tag's key-value criteria
+
+data "aws_rds_clusters" "database" {
+  provider = awscust
+  filter {
+    name = "tagkey"
+    values = ["tagvalue"]
+  }
+}
+```
 
 # Terraform Provider for AWS