Skip to content

Commit

Permalink
docs: Fix typos in in conda-forge.md and remove unused reference in R…
Browse files Browse the repository at this point in the history
…EADME (#762)

- Fix few typos in conda-forge.md
- Removed unused PEP-508 ref in README.md

Signed-off-by: Arthit Suriyawongkul <[email protected]>
  • Loading branch information
bact authored Jan 27, 2025
1 parent e297759 commit 66ece7a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@
OWASP [CycloneDX][link_website] is a full-stack Bill of Materials (BOM) standard
that provides advanced supply chain capabilities for cyber risk reduction.

This Python package provides data models, validators and more,
This Python package provides data models, validators and more,
to help you create/render/read CycloneDX documents.

**This package is not designed for standalone use. It is a software library.**

As of version `3.0.0`, the internal data model was adjusted to allow CycloneDX VEX documents to be produced as per
[official examples](https://cyclonedx.org/capabilities/bomlink/#linking-external-vex-to-bom-inventory) linking VEX to a separate CycloneDX document.

If you're looking for a CycloneDX tool to run to generate (SBOM) software bill-of-materials documents, why not checkout
If you're looking for a CycloneDX tool to run to generate (SBOM) software bill-of-materials documents, why not checkout
[CycloneDX Python][cyclonedx-python] or [Jake][jake].

## Documentation
Expand Down Expand Up @@ -81,5 +81,3 @@ See the [LICENSE][license_file] file for the full license.
[link_slack]: https://cyclonedx.org/slack/invite
[link_discussion]: https://groups.io/g/CycloneDX
[link_twitter]: https://twitter.com/CycloneDX_Spec

[PEP-508]: https://www.python.org/dev/peps/pep-0508/
12 changes: 7 additions & 5 deletions docs/processes/release/conda-forge.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@

Releases of
[_CycloneDX-python-lib_ for Anaconda][CDXlib-conda-forge]
are managed in a [seperate conda-forge feedstock-repository][CDXlib-conda-forge-feedstock-repo]
as [anounced][first-conda-forge-release]
are managed in a [separate conda-forge feedstock-repository][CDXlib-conda-forge-feedstock-repo]
as [announced][first-conda-forge-release]
by [@bollwyvl].

## Current build status

<table><tr><td>All platforms:</td>
<table>
<tr>
<td>All platforms:</td>
<td>
<a href="https://dev.azure.com/conda-forge/feedstock-builds/_build/latest?definitionId=14348&branchName=master">
<img src="https://dev.azure.com/conda-forge/feedstock-builds/_apis/build/status/cyclonedx-python-lib-feedstock?branchName=master">
Expand All @@ -25,8 +27,8 @@ by [@bollwyvl].

## Licensing

The [_CycloneDX-python-lib_ conda-forge feedstock repository][CDXlib-conda-forge-feedstock-repo] is or may be licensed under a differrent form than the _CycloneDX-python-lib_ project itself.
The License of _CycloneDX-python-lib_ stayes [as stated in it's repository][license_file].
The [_CycloneDX-python-lib_ conda-forge feedstock repository][CDXlib-conda-forge-feedstock-repo] is or may be licensed under a different form than the _CycloneDX-python-lib_ project itself.
The License of _CycloneDX-python-lib_ stays [as stated in it's repository][license_file].

[CDXlib-conda-forge]: https://anaconda.org/conda-forge/cyclonedx-python-lib
[CDXlib-conda-forge-feedstock-repo]: https://github.com/conda-forge/cyclonedx-python-lib-feedstock
Expand Down

0 comments on commit 66ece7a

Please sign in to comment.