SystemSh0cker/gocsaf
1
0
Fork 0
mirror of https://github.com/gocsaf/csaf.git synced 2025-12-22 05:40:11 +01:00
Code Issues Releases Activity Actions

API examples: Improved wording in examples/README.md (#499)

Browse source 
* Improved wording in examples/README.md

* Improve wording

* Fix link purl_searcher -> purls_searcher

---------

Co-authored-by: JanHoefelmeyer <hoefelmeyer.jan@gmail.com>
This commit is contained in:
Sascha L. Teichmann 2023-11-07 09:46:27 +01:00 • committed by GitHub
parent 086c4ab48b
commit aa3604ac3d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
examples/README.md
View file

@ -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.