Update README.md

README.md

@@ -1,2 +1,49 @@
 # coverity-on-polaris-workflow
 A Github action workflow for Coverity on Polaris
+
+## Input
+
+```yaml
+inputs:
+  api_url:
+    description: |
+      Coverity on Polaris API URL
+      Usually something along the lines of https://{instance_name}.polaris.synopsys.com
+    required: true
+  access_token:
+    description: 'Polaris access token'
+    required: true
+```
+
+## Usage
+
+```yaml
+name: SAST
+on:
+  workflow_dispatch:
+  workflow_call:
+  schedule:
+    - cron: "0 12 * * *" # Runs at 12:00 everyday
+
+env:
+  DOTNET_NOLOGO: 1
+  DOTNET_CLI_TELEMETRY_OPTOUT: 1
+
+jobs:
+  analyze:
+    name: Capture and send
+    runs-on: ubuntu-latest
+    steps:
+        - name: Checkout repo
+          uses: actions/checkout@v3
+
+        - name: Install dependencies
+          run: |
+            dotnet restore
+
+        - name: Static application security testing
+          uses: visma-prodsec/coverity-on-polaris-workflow@v1
+          with:
+            api_url: ${{ vars.COVERITY_ON_POLARIS_API_URL }}
+            access_token: ${{ secrets.VISMAINDEX_POLARIS_ACCESS_TOKEN }}
+```