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 <[email protected]>
gocsaf · Nov 2, 2023 · 26c630d · 26c630d
1 parent 7fbc012
commit 26c630d
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git 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
@@ -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 → examples/purls_searcher/main.go b/cmd/csaf_searcher/main.go → examples/purls_searcher/main.go