Add supported file formats (#263)

zuplo · Jul 30, 2024 · 36f3aa4 · 36f3aa4
1 parent 2453534
commit 36f3aa4
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -91,13 +91,13 @@ Key features include:
 
 #### Getting Started
 
-To get started install the CLI (detailed below) and start integrating it into
-your development workflow
+To get started install the CLI and start integrating it into your development
+workflow.
 
 ```bash
 npm install rmoa
 
-rmoa lint --filename <openapi-filename>.json --api-key <API_KEY>
+rmoa lint --filename <openapi-filename> --api-key <API_KEY>
 ```
 
 Source code & documentation at [packages/cli](/packages/cli/README.md)

diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -32,10 +32,11 @@ your API Key.
 
 ### Basic
 
-Lint an OpenAPI definition using the CLI's default configuration by running:
+Lint an OpenAPI definition, json or yaml format, using the CLI's default
+configuration by running:
 
 ```bash
-rmoa lint --filename <openapi-filename>.json --api-key <API_KEY>
+rmoa lint --filename <openapi-filename> --api-key <API_KEY>
 ```
 
 ### Advanced
@@ -45,7 +46,7 @@ score (default is 80 out of 100), set the maximum number of allowed warnings &
 errors and get the output in json format.
 
 ```bash
-rmoa lint --filename <openapi-filename>.json --api-key <API_KEY> --minimum-score 60
+rmoa lint --filename <openapi-filename> --api-key <API_KEY> --minimum-score 60
 ```
 
 ### Commands