Skip to content

Commit 3365cd7

Browse files
committed
Update README.md
1 parent 3aad5c6 commit 3365cd7

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[![CodeQL](https://github.com/IBM/audit-ci/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/IBM/audit-ci/actions/workflows/codeql-analysis.yml)
77

88
This module is intended to be consumed by your favourite continuous integration tool to
9-
halt execution if `npm audit`, `yarn audit` or `pnpm audit` finds vulnerabilities at or above the specified
9+
halt execution if `npm audit`, `yarn audit`, or `pnpm audit` finds vulnerabilities at or above the specified
1010
threshold while ignoring allowlisted advisories.
1111

1212
> Note: Use our [codemod](#codemod) to update to [`audit-ci` v6.0.0](https://github.com/IBM/audit-ci/releases/tag/v6.0.0)
@@ -23,8 +23,9 @@ threshold while ignoring allowlisted advisories.
2323
- Yarn Classic workspaces does not audit `devDependencies`. See [this issue](https://github.com/yarnpkg/yarn/issues/7047) for more information.
2424
- Yarn v4 is not supported because it provides similar functionality to `audit-ci`.
2525
For more information, see the [documentation on `yarn npm audit`](https://yarnpkg.com/cli/npm/audit#options).
26+
If you'd like `audit-ci` to support Yarn v4, voice your opinion on [this issue](https://github.com/IBM/audit-ci/issues/332).
2627
- Bun is supported by exporting the `bun.lockb` into a Yarn v1 `yarn.lock` file.
27-
Accordingly, it requires Yarn v1 to run `audit-ci` and it has the same limitations as Yarn v1.
28+
Accordingly, auditing a `bun.lockb` file with `audit-ci` requires Yarn v1.
2829

2930
## Set up
3031

@@ -49,7 +50,7 @@ bun install -D audit-ci
4950
```
5051

5152
The next section gives examples using `audit-ci` in various CI environments.
52-
It assumes that moderate, high, and critical severity vulnerabilities prevent build continuation.
53+
It assumes moderate, high, and critical severity vulnerabilities prevent build continuation.
5354
Also, it suppresses an advisory of `axios` and a transitive advisory of `react-scripts`.
5455

5556
```jsonc

0 commit comments

Comments
 (0)