diff --git a/README.md b/README.md index bcd1a66..90c1fb6 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,32 @@ -# Spectral Lint Action +# Spectral Linter Action -![](https://raw.githubusercontent.com/stoplightio/spectral/master/img/spectral-banner.png) - -This action uses [Spectral 4.x](https://github.com/stoplightio/spectral) to lint your OpenAPI files. +This action uses [Spectral](https://github.com/stoplightio/spectral) from [Stoplight](https://stoplight.io/) to lint your OpenAPI documents, or any other JSON/YAML files. ![](./image.png) + +## Install + +```json +name: Run Spectral on Pull Requests + +on: + - pull_request + +jobs: + build: + name: Run Spectral + runs-on: ubuntu-latest + steps: + + # Check out the repository + - uses: actions/checkout@v1 + + # Run Spectral + - uses: stoplightio/spectral-action@v0.5.5 +``` + +## Configuration + +Spectral Action will respect your [Spectral Rulesets](https://stoplight.io/p/docs/gh/stoplightio/spectral/docs/getting-started/rulesets.md), which can be defined, extended, and overriden by placing `.spectral.yml` in the root of your repository. + +