Update README.md

README.md

@@ -1,7 +1,6 @@
 # Serverless Pipes Plugin
 
-🚧 This is a Work in Progress and we're looking to get inputs from the community
-Making it easier to use Eventbridge pipes with Serverless Framework. Easier Api resembling that of Step Functions
+Serverless Framework plugin called as "pipes", used to create EventBridge Pipes by providing the required event sources, targets and other parameters as needed.
 
 ## Install
 
@@ -15,6 +14,29 @@ or
 yarn add @distinction-dev/serverless-pipes
 ```
 
+## Allowed Services
+At the initial version of the plugin, the below mentioned AWS services are supported for the source, target and enrichment in the EventBridge Pipes. We will expand to other services in the future.
+
+
+### Source
+
+- SQS
+- DynamoDB
+- Kinesis Streams
+
+### Target
+
+- SQS
+- SNS
+- Step Function
+- Lambda Function
+
+### Enrichment
+
+- Lambda Function
+
+
+
 ## Usage
 
 ```yaml
@@ -25,19 +47,31 @@ functions:
         handler: functions/pipeEnricher.handler
 
 pipes:
-    event:
-        # Define Event source
-        sqs:
-            arn:
-                Fn::GetAtt:
-                    - MySourceQueue
-                    - Arn
-    enrichment:
-        function: pipeEnricher
+  testPipe: #pipesName
+    source:
+      sqs:
+        arn:
+          Fn::GetAtt: [SourceSQSQueue, Arn]
     target:
-        sqs:
-            arn:
-                Fn::GetAtt:
-                    - MyTargetQueue
-                    - Arn
+      sqs:
+        arn:
+          Fn::GetAtt: [TargetSNSTopic, TopicArn]
+    enrichment: 
+      name: pipeEnricher
+    iamRolePipes:
+      statements:
+        - Effect: Allow
+          Action:
+            - sns:Subscribe
+            - sns:Publish
+          Resource: '*'
+        - Effect: Allow
+          Action:
+            - sqs:ReceiveMessage
+            - sqs:DeleteMessage
+            - sqs:GetQueueAttributes
+          Resource: '*'
+
 ```
+
+For documentation refer [Docs](docs/index.md)