commit | 57f9fcd788bdf6bc0c0fc5e3f49abc553299a45c | [log] [tgz] |
---|---|---|
author | Steve Winslow <steve@swinslow.net> | Sun Mar 27 11:57:17 2022 -0400 |
committer | GitHub <noreply@github.com> | Sun Mar 27 11:57:17 2022 -0400 |
tree | 868d2827b54d2e6de2e8371b6b99c68693a48bb4 | |
parent | 6ce7cd028e5280d3d27915498320efb98dc7c658 [diff] |
Update readme for 0.3.0-rc1 Signed-off-by: Steve Winslow <steve@swinslow.net>
tools-golang is a collection of Go packages intended to make it easier for Go programs to work with SPDX® files.
2022-03-27: v0.3.0-rc1: added support for saving SPDX JSON files as well as other improvements and bugfixes. See RELEASE-NOTES.md for full details (to be updated for v0.3.0 prior to final release).
tools-golang currently works with files conformant to versions 2.1 and 2.2 of the SPDX specification, available at: https://spdx.dev/specifications
tools-golang provides the following packages:
Examples for how to use these packages can be found in the examples/
directory.
tools-golang doesn't currently do any of the following:
We are working towards adding functionality for all of these. Code contributions are welcome!
tools-golang uses https://github.com/spdx/gordf to manage RDF input and output.
Other than that, tools-golang does not require anything outside the Go standard library.
SPDX tools-golang documentation is available on the pkg.go.dev website at https://pkg.go.dev/github.com/spdx/tools-golang.
Thank you to all of the contributors to spdx/tools-golang. A full list can be found in the GitHub repo and in the release notes.
In particular, thank you to the following for major contributions:
JSON parsing and saving support was added by @specter25 as part of his Google Summer of Code 2021 project.
RDF parsing support was added by @RishabhBhatnagar as part of his Google Summer of Code 2020 project.
As indicated in LICENSE-code
, tools-golang source code files are provided and may be used, at your option, under either:
As indicated in LICENSE-docs
, tools-golang documentation files are provided and may be used under the Creative Commons Attribution 4.0 International license (CC-BY-4.0).
This README.md
file is documentation:
SPDX-License-Identifier: CC-BY-4.0