diff --git a/README.md b/README.md index 712b006..2b4a8c8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Rate My OpenAPI GitHub Action +# ramoa-action
+ramoa-action analyzes an OpenAPI definition file using the Rate My OpenAPI API, +and reports the issues as console output, annotations and action summary. + +The goal of ramoa-action is to help you establish best practices for your +OpenAPI's definitions across multiple categories that include security, +documentation and more. + This action provides the following functionality for GitHub Actions users: - Run the Rate My OpenAPI rules on an OpenAPI spec file - Get a summary of the the RMOA score in the action output - Get annotations on the OpenAPI spec file per run +- Get a link to a detailed report ## Usage +Lint & get a score for your OpenAPI definition. You'll need to create a free api +key at the [Rate My Open API Portal](https://api.ratemyopenapi.com/docs). + See [action.yml](action.yml) diff --git a/action.yml b/action.yml index d406f48..84d3147 100644 --- a/action.yml +++ b/action.yml @@ -2,6 +2,11 @@ name: 'ramoa-action' description: 'GitHub Action to run RMOA lint rules on an OpenAPI spec' author: 'Zuplo' +# branding +branding: + icon: check + color: white + # Define your inputs here. inputs: filepath: