summaryrefslogtreecommitdiffstats
path: root/vendor/spdx-rs/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 12:18:32 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 12:18:32 +0000
commit4547b622d8d29df964fa2914213088b148c498fc (patch)
tree9fc6b25f3c3add6b745be9a2400a6e96140046e9 /vendor/spdx-rs/README.md
parentReleasing progress-linux version 1.66.0+dfsg1-1~progress7.99u1. (diff)
downloadrustc-4547b622d8d29df964fa2914213088b148c498fc.tar.xz
rustc-4547b622d8d29df964fa2914213088b148c498fc.zip
Merging upstream version 1.67.1+dfsg1.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/spdx-rs/README.md')
-rw-r--r--vendor/spdx-rs/README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/vendor/spdx-rs/README.md b/vendor/spdx-rs/README.md
new file mode 100644
index 000000000..fe125e737
--- /dev/null
+++ b/vendor/spdx-rs/README.md
@@ -0,0 +1,40 @@
+<!--
+SPDX-FileCopyrightText: 2021 HH Partners
+
+SPDX-License-Identifier: MIT
+ -->
+
+# SPDX Documents in Rust
+
+[![crates.io-icon]][crates.io] [![docs.rs-icon]][docs.rs]
+
+[crates.io-icon]: https://img.shields.io/crates/v/spdx-rs
+[crates.io]: https://crates.io/crates/spdx-rs
+[docs.rs-icon]: https://img.shields.io/docsrs/spdx-rs
+[docs.rs]: https://docs.rs/spdx-rs
+
+`spdx-rs` parses [SPDX documents] in multiple data formats to Rust structs.
+
+## Data formats
+
+The library has been designed for working with SPDX documents in JSON. This is achieved with
+[Serde], so any data format supported by Serde should work, as long as the naming is consistent with
+that used in JSON SPDX documents.
+
+In addition to serializing and deserializing with Serde, deserializing documents in tag value format
+is supported with a custom parser.
+
+## Usage
+
+Simple usage examples for parsing documents from JSON and tag-value formats can be found in the
+[integration tests].
+
+[SPDX documents]: https://spdx.github.io/spdx-spec/
+[Serde]: https://serde.rs/
+[integration tests]: https://github.com/doubleopen-project/spdx-rs/tree/main/tests/integration.rs
+
+## License
+
+The project is licensed under the [MIT License][LICENSE.txt].
+
+[LICENSE.txt]: license.txt