Skip to content

Commit

Permalink
docs: improve readme
Browse files Browse the repository at this point in the history
 * 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
  • Loading branch information
bernhardreiter committed Dec 14, 2023
1 parent 47768ff commit 8651239
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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*
Expand Down

0 comments on commit 8651239

Please sign in to comment.