Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
Signed-off-by: Jan Kowalleck <[email protected]>
  • Loading branch information
jkowalleck authored May 14, 2024
1 parent c620b95 commit 2e5df37
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,14 @@ Currently, there are no releases nor pre-builds. This means, the only way to tes
1. Install the project dependencies - run: `yarn install`
1. Create the bundle - run: `yarn build`

Then, import the bundle into your project using `yarn plugin import {pathToYourClone}/bundles/@yarnpkg/plugin-cyclonedx.js`,
Then,
import the plugin bundle into your project — like so:
```shell
yarn plugin import {pathToYourClone}/bundles/@yarnpkg/plugin-cyclonedx.js`,
```
or reference it in environment variable [`YARN_PLUGINS`](https://yarnpkg.com/advanced/plugin-tutorial#dynamically-loading-plugins-using-the-yarn_plugins-environment-variable) — like so:

```shell
YARN_PLUGINS=.../bundles/@yarnpkg/plugin-cyclonedx.js yarn sbom --help
YARN_PLUGINS={pathToYourClone}/bundles/@yarnpkg/plugin-cyclonedx.js yarn sbom --help
```

## Usage
Expand Down

0 comments on commit 2e5df37

Please sign in to comment.