From 8651239229085971a9634035c683fbea5b572f3e Mon Sep 17 00:00:00 2001 From: Bernhard Reiter Date: Thu, 14 Dec 2023 10:36:09 +0100 Subject: [PATCH] docs: improve readme * Add envisoned usage paragraph to explain major design choices a bit. * Add "module" to make it more obvious that this is a component to be integrated.:w --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 741cc32..7a65c25 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ # CSAF Webview -A browser based web app to: +A browser based web app (module) to: - Display the contents of a [CSAF 2.0](https://docs.oasis-open.org/csaf/csaf/v2.0/csaf-v2.0.html) @@ -23,6 +23,11 @@ Note: As of 2023-12-14 all but one server do not allow web applications due to _CORS restrictions_ often. See https://github.com/oasis-tcs/csaf/issues/653 for more details. +The envisoned usage is to be integrated in a larger application. +Therefore it is kept simple and stylable. +A backend can act as a proxy to avoid the problems caused by +CSAF Providers missing `Access-Control-Allow-Origin: *` headers. + ![](docs/app_single.png) *Displaying a single document*