Skip to content

Commit

Permalink
Added new install docs and npm publish action.
Browse files Browse the repository at this point in the history
It should publish updates automatically, now we just need to get homebrew working and the machine is rolling.
  • Loading branch information
daveshanley committed Jul 20, 2022
1 parent 3caabb1 commit 06c3ec8
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 9 deletions.
15 changes: 15 additions & 0 deletions .github/workflows/npm-publish.yml
Original file line number Diff line number Diff line change
@@ -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 }}
36 changes: 27 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 06c3ec8

Please sign in to comment.