Skip to content

Commit

Permalink
Add detailed intro on CLI readme (#264)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcampos authored Jul 30, 2024
1 parent 36f3aa4 commit 697e0a5
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,17 @@
<p align="center">
<a href="https://ratemyopenapi.com/">
<img src="https://cdn.zuplo.com/static/logos/logo.svg" height="70">
<h3 align="center">Rate My Open API</h3>
</a>
</p>

At Zuplo we believe that the better the quality of an OpenAPI document, the
better the developer experience will be for the consumers of that API. This
experience is important for the success of an API.

Rate My OpenAPI is a suite of tools designed to help software developers using
OpenAPI to meet high standards of quality and usability when designing and
developing their APIs.

The CLI tool is perfect for developers who prefer working from the command line
or need to integrate quality checks into their development workflow. It provides
the same lint results as the website with the added benefit of it being easier
Expand Down

0 comments on commit 697e0a5

Please sign in to comment.