Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Instructions for binary creation
  • Loading branch information
caesartcs authored Sep 15, 2022
1 parent e761898 commit cca99b4
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,23 @@ Note: **This repository is not in active developemnt and critical bug fixes only
## Notice
**snyk2spdx does not support using the `--all-projects` flag with `snyk test`. Please use only `snyk test`**

## Installation
1. Install the npm module `pkg`.

`npm install -g pkg`

2. Install the snyk2spdx npm module.
```
cd snyk2spdx
npm install [ --legacy-peer-deps]
```
- `--legacy-peer-deps` might be necessary to install the module due to old dependencies.

3. Turn the module into a binary.

`pkg .`


## Usage
- Basic
`snyk test --json | snyk2spdx`
Expand Down

0 comments on commit cca99b4

Please sign in to comment.