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 <[email protected]>
gocsaf · Nov 8, 2023 · 65fae93 · 65fae93
1 parent 466d2c6
commit 65fae93
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git 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
@@ -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.