Skip to content

Commit 3773756

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

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -173,8 +173,11 @@ bom.metadata.component.dependencies.add(componentA.bomRef)
173173

174174
## API documentation
175175

176-
There is no pre-rendered documentation at the time.
177-
Instead, there are annotated type definitions, so that your IDE and tools may pick up the documentation when you use this library downstream.
176+
We ship annotated type definitions, so that your IDE and tools may pick up the documentation when you use this library downstream.
177+
178+
<!--
179+
There are also pre-rendered documentation hosted on [readthedocs](https://cyclonedx-javascript-library.readthedocs.io).
180+
-->
178181

179182
Additionally, there is a prepared set of configs for [TypeDoc](https://typedoc.org), so that you can build the API documentation from source via `npm run api-doc`.
180183

0 commit comments

Comments
 (0)