From 39280e08cf99b0560c0f4cb49c4d889c43936ee2 Mon Sep 17 00:00:00 2001
From: Ritik Jain <60597329+re-Tick@users.noreply.github.com>
Date: Fri, 7 Jan 2022 23:58:14 +0530
Subject: [PATCH] Added ReadMe.md (#21)

---
 README.md | 111 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 110 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d15db55..7ad42eb 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,110 @@
-# go-sdk
\ No newline at end of file
+# Keploy Go-SDK
+
+This is the client SDK for Keploy API testing platform. There are 2 modes:
+1. **Capture mode**
+    1. Captures requests, response and all external calls and sends to Keploy server.
+    2. After keploy server removes duplicates, it then runs the request on the API again to identify noisy fields.
+    3. Sends the noisy fields to the keploy server to be saved along with the testcase. 
+2. **Test mode**
+    1. Fetches testcases for the app from keploy server. 
+    2. Calls the API with same request payload in testcase.
+    3. Mocks external calls based on data stored in the testcase. 
+    4. Validates the respones and uploads results to the keploy server 
+
+
+## Contents
+
+1. [Installation](#installation)
+2. [Usage](#usage)
+3. [Configure](#configure)
+4. [Supported Routers](#supported-routers)
+5. [Supported Databases](#supported-databases)
+6. [Support Clients](#supported-clients)
+
+## Installation
+```bash
+go get -u github.com/keploy/go-sdk
+```
+## Usage
+
+```go
+import(
+        "github.com/keploy/go-sdk/integrations"
+	"github.com/keploy/go-sdk/keploy"
+)
+```
+
+Create your app instance
+```go
+kApp := keploy.NewApp("<app_name>", "<license_key>", "<keploy_host>", "app_ip_addr", "app_port")
+```
+For example: 
+```go
+kApp := keploy.NewApp("my_app", "adkjhf9adf9adf", "", "0.0.0.0", "8080")
+```
+    
+## Configure
+```
+export KEPLOY_SDK_MODE="test"
+```
+### KEPLOY_SDK_MODE
+There are 3 modes:
+ - **Capture**: Sets to capture mode.
+ - **Test**: Sets to test mode. 
+ - **Off**: Turns off all the functionality provided by the API
+
+**Note:** `KEPLOY_SDK_MODE` value is case sensitive. 
+
+## Supported Routers
+### 1. WebGo
+#### WebGoV4
+```go
+kApp := keploy.NewApp("my_app", "adkjhf9adf9adf", "", "0.0.0.0", "8080")
+integrations.WebGoV4(kApp, router)
+router.Start()
+```
+#### WebGoV6
+```go
+kApp := keploy.NewApp("my_app", "adkjhf9adf9adf", "", "0.0.0.0", "8080")
+integrations.WebGoV6(kApp, router)
+router.Start()
+```
+
+### 2. Echo
+```go
+e := echo.New()
+kApp := keploy.NewApp("my_app", "adkjhf9adf9adf", "", "0.0.0.0", "8080")
+integrations.EchoV4(kApp, e)
+e.Start(":8080")
+```
+
+## Supported Databases
+### 1. MongoDB
+```go
+db  := client.Database("testDB")
+col := integrations.NewMongoDB(db.Collection("Demo-Collection"))
+```
+Following operations are supported:<br>
+- FindOne - Err and Decode method of mongo.SingleResult<br>
+- Find - Next and Decode methods of mongo.cursor<br>
+- InsertOne<br>
+- InsertMany<br>
+- UpdateOne<br>
+- UpdateMany<br>
+- DeleteOne<br>
+- DeleteMany
+### 2. DynamoDB
+```go
+client := integrations.NewDynamoDB(dynamodb.New(sess))
+```
+Following operations are supported:<br>
+- QueryWithContext
+- GetItemWithContext
+- PutItemWithContext
+## Supported Clients
+### gRPC
+```go
+kApp := keploy.NewApp("my_app", "adkjhf9adf9adf", "", "0.0.0.0", "8080")
+conn, err := grpc.Dial(address, grpc.WithInsecure(), integrations.WithClientUnaryInterceptor(kApp))
+```
+Note: Currently streaming is not yet supported.