Skip to content

Commit

Permalink
updated readme with 0.5.0 details
Browse files Browse the repository at this point in the history
Signed-off-by: quobix <[email protected]>
  • Loading branch information
daveshanley committed Nov 18, 2023
1 parent 7d152ec commit c604716
Showing 1 changed file with 31 additions and 4 deletions.
35 changes: 31 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,6 @@ like our _very kind_ sponsors:
[zuplo](https://zuplo.com)



---

## Come chat with us
Expand All @@ -103,8 +102,23 @@ come say hi!

## Documentation

🔥 **New in** `v0.5+` 🔥 : **Multi-file linting** now available for the `lint` command.

Want to lint multiple files at once? Now you can!

```shell
vacuum lint file1.json path/to/file2.yaml file3.json`
```

Want to suck in a ton of files? Use a **glob** pattern!

```shell
vacuum lint some/path/**/*.yaml`
```


---
🔥 **New in** `v0.3.0+` 🔥 : [Custom JavaScript Functions](https://quobix.com/vacuum/api/custom-javascript-functions/) are now available out of the box.
`v0.3+`: [Custom JavaScript Functions](https://quobix.com/vacuum/api/custom-javascript-functions/) are now available out of the box.

Write custom functions in JavaScript and use them in any ruleset. No need
to compile golang code to extend vacuum anymore!
Expand All @@ -113,7 +127,7 @@ to compile golang code to extend vacuum anymore!


---
**New in** `v0.2.0+`: [OWASP API rules](https://quobix.com/vacuum/rules/owasp/) are now available out of the box.
`v0.2+`: [OWASP API rules](https://quobix.com/vacuum/rules/owasp/) are now available out of the box.

[Learn more about enabling OWASP API rules](https://quobix.com/vacuum/rulesets/owasp/).

Expand Down Expand Up @@ -163,7 +177,7 @@ See all the documentation at https://quobix.com/vacuum

---

> **vacuum can suck all the lint of a 5mb OpenAPI spec in about 230ms.**
> **vacuum can suck all the lint of a 5mb OpenAPI spec in milliseconds.**
Designed to reliably lint OpenAPI specifications, **very, very quickly**. Including _very large_ ones. Spectral can be quite slow
when used as an API and does not scale for enterprise applications.
Expand Down Expand Up @@ -230,6 +244,19 @@ in your favorite browser and explore the results.
./vacuum lint -d <your-openapi-spec.yaml>
```
## Lint multiple files at once
```
./vacuum lint -d <spec1.yaml> <spec2.yaml> <spec3.yaml>
```
## Lint multiple files using a glob pattern
```
./vacuum lint -d some/path/**/*.yaml
```
## See full linting report with inline code snippets
```
Expand Down

0 comments on commit c604716

Please sign in to comment.