From 3bdd80df3a08058518671533f430a2195bd83c71 Mon Sep 17 00:00:00 2001 From: "Sascha L. Teichmann" Date: Tue, 31 Oct 2023 20:39:17 +0100 Subject: [PATCH 1/3] move csaf_searcher to a lower prio place --- 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 3a732838..1f5c907f 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 how to use `github.com/csaf-poc/csaf_distribution` as an API. +Currently this 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 00000000..65c858f1 --- /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 From afeec1d192fba2520d46629bc4b7ef593a715d61 Mon Sep 17 00:00:00 2001 From: "Sascha L. Teichmann" Date: Thu, 2 Nov 2023 12:31:20 +0100 Subject: [PATCH 2/3] Adjust wording --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1f5c907f..ac6f821e 100644 --- a/README.md +++ b/README.md @@ -28,8 +28,8 @@ is a CSAF Aggregator, to list or mirror providers. ## Other stuff ### [examples](./examples/README.md) -are small examples how to use `github.com/csaf-poc/csaf_distribution` as an API. -Currently this work in progress. They may be extended and/or changed in the future. +are small examples of how to use `github.com/csaf-poc/csaf_distribution` as an API. +Currently this is work in progress. They may be extended and/or changed in the future. ## Setup Binaries for the server side are only available and tested From bbede80f7c6073009e5d9f15c3c1bf8f07633393 Mon Sep 17 00:00:00 2001 From: JanHoefelmeyer Date: Thu, 2 Nov 2023 13:08:42 +0100 Subject: [PATCH 3/3] Grammar fix #2 'this is work in progress' -> 'This is a work in progress'... --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ac6f821e..97b6ed45 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ is a CSAF Aggregator, to list or mirror providers. ### [examples](./examples/README.md) are small examples of how to use `github.com/csaf-poc/csaf_distribution` as an API. -Currently this is work in progress. They may be extended and/or changed in the future. +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