From f48026eb18b2e22dceff8eab5f97c7584c33cedc Mon Sep 17 00:00:00 2001
From: Rudraksh Pareek <rudrakshpareek3601@gmail.com>
Date: Thu, 5 Aug 2021 19:52:16 +0530
Subject: [PATCH] update README

Signed-off-by: Rudraksh Pareek <rudrakshpareek3601@gmail.com>
---
 README.md  | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++--
 action.yml | 10 +++++++++
 2 files changed, 68 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 693d022..7f2bc2a 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,61 @@
-# layer5-repo-template
-This repository is used as the boilerplate for consistency across all Layer5 repos.
+# Meshery SMP Action
+This repository is used for storing a GitHub action for performing SMP tests using Meshery
+
+## Inputs
+```yaml
+  # token to connect with the remote provider
+  provider_token:
+    description: "Provider token to use. NOTE: value of the 'token' key in auth.json"
+    required: true
+
+  # platform to deploy meshery
+  platform:
+    description: "Platform to deploy meshery on. Possible values: docker, kubernetes"
+    default: docker
+
+  # SUPPLY EITHER "profile_filename" or profile_name
+
+  # name of the file storing the performance profile (keep in .github)
+  profile_filename:
+    description: "Name of the file containing SMP profile"
+
+  # name of the prformance profile to use
+  profile_name:
+    description: "Name of the performance profile"
+```
+
+## Sample configuration
+```yaml
+name: Testing SMP action
+on:
+  push:
+    branches:
+      'perf'
+
+jobs:
+  job1:
+    name: Run Performance Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v2
+        with:
+          ref: 'perf'
+
+      - name: Deploy k8s
+        uses: manusa/actions-setup-minikube@v2.4.1
+        with:
+          minikube version: 'v1.21.0'
+          kubernetes version: 'v1.20.7'
+          driver: docker
+
+      - name: Performance test
+        uses: layer5io/meshery-smp-action@master
+        with:
+          provider_token: ${{ secrets.PROVIDER_TOKEN }}
+          platform: docker
+          profile_name: demo
+```
 
 <div>&nbsp;</div>
 
diff --git a/action.yml b/action.yml
index 39e3d46..fc1d3f1 100644
--- a/action.yml
+++ b/action.yml
@@ -3,13 +3,23 @@ description: "Validate SMP specification using Meshery"
 author: "Layer5"
 
 inputs:
+  # token to connect with the remote provider
   provider_token:
     description: "Provider token to use. NOTE: value of the 'token' key in auth.json"
+    required: true
+
+  # platform to deploy meshery
   platform:
     description: "Platform to deploy meshery on. Possible values: docker, kubernetes"
     default: docker
+
+  # SUPPLY EITHER "profile_filename" or profile_name
+
+  # name of the file storing the performance profile (keep in .github)
   profile_filename:
     description: "Name of the file containing SMP profile"
+
+  # name of the prformance profile to use
   profile_name:
     description: "Name of the performance profile"