@quobix/vacuum 0.0.42 → 0.0.44
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="logo.png" alt="vacuum" height="300px"/>
|
|
3
|
+
</p>
|
|
3
4
|
# vacuum - The world's fastest OpenAPI & Swagger linter.
|
|
4
5
|
|
|
5
6
|
|
|
@@ -34,6 +35,20 @@ yarn global add @quobix/vacuum
|
|
|
34
35
|
curl -fsSL https://quobix.com/scripts/install_vacuum.sh | sh
|
|
35
36
|
```
|
|
36
37
|
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
## Sponsors
|
|
42
|
+
If your company is using `vacuum`, please considering [supporting this project](https://github.com/sponsors/daveshanley),
|
|
43
|
+
like our _very kind_ sponsors:
|
|
44
|
+
|
|
45
|
+
<p align="center">
|
|
46
|
+
<a href="//www.speakeasyapi.dev"><img src=".github/sponsors/speakeasy.png" alt="Speakeasy" height="100px"/></a>
|
|
47
|
+
<br/>
|
|
48
|
+
<a href="//www.speakeasyapi.dev">Speakeasy</a>
|
|
49
|
+
</p>
|
|
50
|
+
|
|
51
|
+
---
|
|
37
52
|
|
|
38
53
|
## Documentation
|
|
39
54
|
|
|
@@ -73,7 +88,6 @@ See all the documentation at https://quobix.com/vacuum
|
|
|
73
88
|
- [Recommended Rules](https://quobix.com/vacuum/rulesets/recommended/)
|
|
74
89
|
- [Custom Rules](https://quobix.com/vacuum/rulesets/custom-rulesets/)
|
|
75
90
|
|
|
76
|
-
|
|
77
91
|
---
|
|
78
92
|
|
|
79
93
|
> **vacuum can suck all the lint of a 5mb OpenAPI spec in about 230ms.**
|
|
@@ -134,8 +148,7 @@ go build vacuum.go
|
|
|
134
148
|
|
|
135
149
|
## Running vacuum via Docker
|
|
136
150
|
|
|
137
|
-
vacuum is available as a container, you can pull the image from
|
|
138
|
-
[Docker Hub](https://hub.docker.com/repository/docker/dshanley/vacuum/general)
|
|
151
|
+
vacuum is available as a container, you can pull the image from [Docker Hub](https://hub.docker.com/r/dshanley/vacuum)
|
|
139
152
|
|
|
140
153
|
```
|
|
141
154
|
docker pull dshanley/vacuum
|
|
@@ -296,4 +309,4 @@ The `lint`, `dashboard` and `spectral-report` commands all accept a `-r` or `--r
|
|
|
296
309
|
|
|
297
310
|
Let me know what you think.
|
|
298
311
|
|
|
299
|
-
> Logo gopher is modified, originally from [egonelbre](https://github.com/egonelbre/gophers)
|
|
312
|
+
> Logo gopher is modified, originally from [egonelbre](https://github.com/egonelbre/gophers)
|