Skip to content

Commit edaf986

Browse files
committed
docs
Signed-off-by: Jan Kowalleck <[email protected]>
1 parent a48ff40 commit edaf986

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

README.md

+11
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,17 @@ pnpm add github:CycloneDX/cyclonedx-javascript-library
112112
yarn add @cyclonedx/cyclonedx-library@github:CycloneDX/cyclonedx-javascript-library # only with yarn-2
113113
```
114114

115+
## Optional Dependencies
116+
117+
Some dependencies are optional. See the shipped `package.json` for details and version constraints.
118+
119+
* XML serialization only on NodeJS requires any of :
120+
* [`xmlbuilder2`](https://www.npmjs.com/package/xmlbuilder2)
121+
* JSON validation requires all of:
122+
* [`ajv`](https://www.npmjs.com/package/ajv)
123+
* [`ajv-formats`](https://www.npmjs.com/package/ajv-formats)
124+
* [`ajv-formats-draft2019`](https://www.npmjs.com/package/ajv-formats-draft2019)
125+
115126
## Usage
116127

117128
See extended [examples].

webpack.config.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,10 @@ const configBase = {
5656
}
5757
},
5858
externals: {
59-
'packageurl-js': 'packageurl-js',
6059
'ajv': 'ajv',
6160
'ajv-formats': 'ajv-formats',
62-
'ajv-formats-draft2019': 'ajv-formats-draft2019'
61+
'ajv-formats-draft2019': 'ajv-formats-draft2019',
62+
'packageurl-js': 'packageurl-js'
6363
}
6464
}
6565

0 commit comments

Comments
 (0)