From aa3604ac3d7a9af3b4d93693185d4deafd1ec822 Mon Sep 17 00:00:00 2001 From: "Sascha L. Teichmann" Date: Tue, 7 Nov 2023 09:46:27 +0100 Subject: [PATCH] API examples: Improved wording in examples/README.md (#499) * Improved wording in examples/README.md * Improve wording * Fix link purl_searcher -> purls_searcher --------- Co-authored-by: JanHoefelmeyer --- examples/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/examples/README.md b/examples/README.md index 65c858f..d6286fb 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. +* [purls_searcher](./purls_searcher/main.go) is a tool to search for PURLs in local advisories by given product IDs.