diff --git a/README.md b/README.md index a1a81d3..907d301 100644 --- a/README.md +++ b/README.md @@ -5,26 +5,37 @@ scenarios and use cases. The repository is organized by profiles which represents a set of scenarios and use cases for a particular domain (e.g. security, license compliance). -Each directory contains a README.md file describing the profile and the -examples contained within that directory. - -The [`presentations`](./presentations/) directory contains examples included in -various SPDX presentations. - -Please note that this repository does not contain all of the supported fields -nor all of the supported serialization formats in the latest version of the -specification. -Additional version-specific examples can be found in the `examples` directory -of each specification version: +- [AI](./ai/) +- [Dataset](./dataset/) +- [Software](./software/) -- [v3.0.1](https://github.com/spdx/spdx-spec/tree/development/v3.0.1/examples) -- [v2.3.1](https://github.com/spdx/spdx-spec/tree/development/v2.3.1/examples) - -More guidance on using SPDX, including how to use SPDX license list short -identifiers in source files and leverage SPDX for compliance with standards and -regulations, is available in the [`spdx/using`](https://github.com/spdx/using/) -repository. +Each directory contains a README.md file describing the profile and the +examples contained within that directory. +Please note that they do not contain all supported fields or serialization +formats specified in the latest version of the specification. + +## More examples + +- The [`presentations`](./presentations/) directory in this repository + contains examples included in various SPDX presentations. +- Moreover, in a page for each field in + [SPDX Specification](https://spdx.github.io/spdx-spec/), there can also + be a code snippet demonstrating how to use that particular field. +- Additional version-specific examples can be found in the `examples` directory + of each specification version in [`spdx-spec`](https://github.com/spdx/spdx-spec/) repository. + For example: + - [`v3.0.1`](https://github.com/spdx/spdx-spec/tree/development/v3.0.1/examples) + - [`v2.3.1`](https://github.com/spdx/spdx-spec/tree/development/v2.3.1/examples) +- JSON-LD serialization examples can be found in + [`spdx/spdx-3-model`](https://github.com/spdx/spdx-3-model/blob/main/serialization/jsonld/examples.md) + repository. +- More guidance on using SPDX, including how to use SPDX License List short + identifiers in source files and leverage SPDX for compliance with standards + and regulations, is available in the [`spdx/using`](https://github.com/spdx/using/) + repository. +- The Playground repository at [`spdx-3-serialization-prototype-playground`](https://github.com/spdx/spdx-3-serialization-prototype-playground) + contains some examples that may not pass validation. ## Licenses