From 697e0a53ab8773ca090730a1aafa756bffbacb5c Mon Sep 17 00:00:00 2001 From: lcampos Date: Mon, 29 Jul 2024 18:20:47 -0700 Subject: [PATCH] Add detailed intro on CLI readme (#264) --- packages/cli/README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/packages/cli/README.md b/packages/cli/README.md index 322a16d..007d990 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -3,10 +3,17 @@

-

Rate My Open API

+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