diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml new file mode 100644 index 00000000..67766767 --- /dev/null +++ b/.github/workflows/npm-publish.yml @@ -0,0 +1,15 @@ +on: push + +jobs: + publish: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 + with: + node-version: 12 + - run: npm install + - run: npm test + - uses: JS-DevTools/npm-publish@v1 + with: + token: ${{ secrets.NPM_TOKEN }} \ No newline at end of file diff --git a/README.md b/README.md index eafb5cc2..d08cdc65 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,31 @@ An **ultra-super-fast**, lightweight OpenAPI linter and quality checking tool, w It's also compatible with existing [Spectral](https://github.com/stoplightio/spectral) rulesets. +## Install using [homebrew](https://brew.sh) tap + +``` +brew install daveshanley/vacuum/vacuum +``` + +## Install using [npm](https://npmjs.com) + +``` +npm i -g @quobix/vacuum +``` + +## Install using [yarn](https://yarnpkg.com/) + +``` +yarn global add @quobix/vacuum +``` + +## Install using curl + +``` +curl -fsSL https://quobix.com/scripts/install_vacuum.sh | sh +``` + + ## Documentation ### [Quick Start Guide 🚀](https://quobix.com/vacuum/start) @@ -78,20 +103,13 @@ No external dependencies, the HTML report will run completely offline. --- -If you want to try out vacuum: - -> Please be warned, this is _early_ code. I am actively working on it. ->> **_Supports OpenAPI Version 2 (Swagger) and Version 3+_** +> **_Supports OpenAPI Version 2 (Swagger) and Version 3+_** You can use either **YAML** or **JSON** vacuum supports both. -## Install using [homebrew](https://brew.sh) tap -``` -brew install daveshanley/vacuum/vacuum -``` -> This is the _recommended_ way to consume the binary version of vacuum. + ## Check out the code