From 26c630df4a9e46dd24ed16fe20a4b789a8516c4a Mon Sep 17 00:00:00 2001 From: "Sascha L. Teichmann" Date: Thu, 2 Nov 2023 14:12:41 +0100 Subject: [PATCH] API examples: move csaf_searcher to a lower prio place (#489) * move csaf_searcher to a lower prio place * Adjust wording * Grammar fix #2 'this is work in progress' -> 'This is a work in progress'... --------- Co-authored-by: JanHoefelmeyer --- README.md | 9 ++++++--- examples/README.md | 5 +++++ {cmd/csaf_searcher => examples/purls_searcher}/main.go | 0 3 files changed, 11 insertions(+), 3 deletions(-) create mode 100644 examples/README.md rename {cmd/csaf_searcher => examples/purls_searcher}/main.go (100%) diff --git a/README.md b/README.md index 4fde787..293c9a0 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,6 @@ Can be used for automated forwarding of CSAF documents. ### [csaf_validator](docs/csaf_validator.md) is a tool to validate local advisories files against the JSON Schema and an optional remote validator. -### [csaf_searcher](docs/csaf_searcher.md) -is a tool to search through local advisories. It finds PURLs based on the product ID of an advisory. - ## Tools for advisory providers ### [csaf_provider](docs/csaf_provider.md) @@ -28,6 +25,12 @@ is a tool for testing a CSAF Trusted Provider according to [Section 7 of the CSA ### [csaf_aggregator](docs/csaf_aggregator.md) is a CSAF Aggregator, to list or mirror providers. +## Other stuff + +### [examples](./examples/README.md) +are small examples of how to use `github.com/csaf-poc/csaf_distribution` as an API. +Currently this is a work in progress. They may be extended and/or changed in the future. + ## Setup Binaries for the server side are only available and tested for GNU/Linux-Systems, e.g. Ubuntu LTS. diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..65c858f --- /dev/null +++ b/examples/README.md @@ -0,0 +1,5 @@ +# API examples + +A currenty very short list how to use `github.com/csaf-poc/csaf_distribution` as a library: + +* (purl_searcher)[./purl_searcher/main.go] is a tool to search through local advisories. It finds PURLs based on the product ID of an advisory. diff --git a/cmd/csaf_searcher/main.go b/examples/purls_searcher/main.go similarity index 100% rename from cmd/csaf_searcher/main.go rename to examples/purls_searcher/main.go