From 65fae93a812fdbae93f975dcfa61e031d131a419 Mon Sep 17 00:00:00 2001 From: "Bernhard E. Reiter" Date: Wed, 8 Nov 2023 10:40:23 +0100 Subject: [PATCH] docs: underline that we are _not_ offering an API yet (#502) * 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 --- README.md | 6 ++++-- examples/README.md | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f2690b91..022b1497 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/examples/README.md b/examples/README.md index d6286fb9..a70ea09a 100644 --- a/examples/README.md +++ b/examples/README.md @@ -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.