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

docs: underline that we are _not_ offering an API yet (#502)

Browse source 
* docs: move link to final CSAF 2.0 in README

* docs: underline that we are _not_ offering an API yet

* Grammar fix

---------

Co-authored-by: JanHoefelmeyer <hoefelmeyer.jan@gmail.com>
This commit is contained in:
Bernhard E. Reiter 2023-11-08 10:40:23 +01:00 • committed by GitHub
parent 466d2c6ab7
commit 65fae93a81
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -31,8 +31,10 @@ 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.
are small examples of how to use `github.com/csaf-poc/csaf_distribution`
as an API. Currently this is a work in progress, as usage of this repository
as a library to access is _not officially supported_, e.g.
see https://github.com/csaf-poc/csaf_distribution/issues/367 .
## Setup
Binaries for the server side are only available and tested

6
examples/README.md
View file

@ -1,6 +1,8 @@
# API examples
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.
An experimental example of how to use `github.com/csaf-poc/csaf_distribution`
as a library.
As usage of the repository as an API is currently a _work in progress_,
these examples are likely to be changed.
* [purls_searcher](./purls_searcher/main.go) is a tool to search for PURLs in local advisories by given product IDs.