From bc7674dfc4bef9d454867e31a84936e93cab0887 Mon Sep 17 00:00:00 2001 From: "Sascha L. Teichmann" Date: Mon, 6 Nov 2023 13:58:20 +0100 Subject: [PATCH 1/3] Improved wording in examples/README.md --- examples/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/examples/README.md b/examples/README.md index 65c858f1..c6ad06ce 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,5 +1,6 @@ # API examples -A currenty very short list how to use `github.com/csaf-poc/csaf_distribution` as a library: +A currenty very short list how to use `github.com/csaf-poc/csaf_distribution` as a library. +As the API is currently WIP these are are likely to be modified or extented. -* (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. +* [purl_searcher](./purl_searcher/main.go) is a tool to search PURLs in local advisories. It finds them by the product IDs. From eb270509317f96b5d14c02b4d82f68e86b220290 Mon Sep 17 00:00:00 2001 From: "Sascha L. Teichmann" Date: Mon, 6 Nov 2023 14:18:18 +0100 Subject: [PATCH 2/3] Improve wording --- examples/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/README.md b/examples/README.md index c6ad06ce..8c6ae707 100644 --- a/examples/README.md +++ b/examples/README.md @@ -3,4 +3,4 @@ A currenty very short list how to use `github.com/csaf-poc/csaf_distribution` as a library. As the API is currently WIP these are are likely to be modified or extented. -* [purl_searcher](./purl_searcher/main.go) is a tool to search PURLs in local advisories. It finds them by the product IDs. +* [purl_searcher](./purl_searcher/main.go) is a tool to search for PURLs in local advisories by given product IDs. From ec775ec9138432922e1db69318fb75002e7283a0 Mon Sep 17 00:00:00 2001 From: JanHoefelmeyer Date: Tue, 7 Nov 2023 07:12:22 +0100 Subject: [PATCH 3/3] Fix link purl_searcher -> purls_searcher --- examples/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/README.md b/examples/README.md index 8c6ae707..d6286fb9 100644 --- a/examples/README.md +++ b/examples/README.md @@ -3,4 +3,4 @@ A currenty very short list how to use `github.com/csaf-poc/csaf_distribution` as a library. As the API is currently WIP these are are likely to be modified or extented. -* [purl_searcher](./purl_searcher/main.go) is a tool to search for PURLs in local advisories by given product IDs. +* [purls_searcher](./purls_searcher/main.go) is a tool to search for PURLs in local advisories by given product IDs.