diff --git a/README.md b/README.md index f84c998..8376572 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ Refer to [RFC2119](https://www.ietf.org/rfc/rfc2119) for details. ### Validating your API Guidelines against OpenAPI Specification -In the `ruleset.md` file you can find a digest of API Guidelines rules which you can validating your API description documents with. If you are using OpenAPI Specification as the API description format you can also leverage the `spectral.yaml` ruleset to automatically verify your specification compliance using [Spectral](github.com/stoplightio/spectral). +In the `ruleset.md` file you can find a digest of API Guidelines rules which you can validating your API description documents with. If you are using OpenAPI Specification as the API description format you can also leverage the `.spectral.yaml` ruleset to automatically verify your specification compliance using [Spectral](github.com/stoplightio/spectral). To install Spectral you will need Node.js and a package manager (npm or yarn). @@ -55,7 +55,7 @@ npm install -g @stoplight/spectral yarn global add @stoplight/spectral ``` -Once installed, to verify your OAS file with spectral execute `spectral lint PATH_TO_YOUR_OAS -r spectral.yml` +Once installed, to verify your OAS file with spectral execute `spectral lint PATH_TO_YOUR_OAS` having the `.spectral.yaml` file inside the directory from which you are calling the command. For further documentation on Spectral refer to their [documentation](https://stoplight.io/p/docs/gh/stoplightio/spectral/README.md).