Improve readme and icon, to be ready for publishing to GH Marketplace

bridgecrewio · Apr 18, 2020 · 803f802 · 803f802
1 parent 790ad75
commit 803f802
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -3,8 +3,10 @@
 This Github Action runs [Checkov](https://github.com/bridgecrewio/checkov) against an Infrastructure-as-Code repository. Checkov performs static security analysis of Terraform & CloudFormation Iaac.
 
 ## Inputs
+(None) 
 
 ## Outputs
+(None)
 
 ## Example usage
 
@@ -19,6 +21,6 @@ jobs:
 
       - name: Run Checkov action
         id: checkov
-        uses: cmavr8/checkov-action@v2
+        uses: cmavr8/checkov-action@master
 ```
-Note that this example uses a static version (`v2`), but you could also use `master`..
+Note that this example uses the latest version (`master`) but you could also use `static a version (e.g. `v3`).
diff --git a/action.yml b/action.yml
@@ -2,6 +2,9 @@
 name: 'Checko Github Action'
 author: 'Chris Mavrakis'
 description: 'Run Checkov against IaC'
+branding:
+  icon: 'shield'
+  color: 'purple'
 runs:
   using: 'docker'
   image: 'Dockerfile'