From 2bb2a2e018affa530e2b59edc5832c4ccb66457f Mon Sep 17 00:00:00 2001 From: "Bernhard E. Reiter" Date: Fri, 29 Sep 2023 04:40:32 +0200 Subject: [PATCH] docs: update main README (#469) * Change release action to use elder Ubuntu runner * use `ubuntu-20.04` so we get binaries that are more compatible with elder GNU/Linux distribution, because go binaries link to glibc (for some operating system operations like dns). resolve #456 * docs: update main README * introduce more structure and put commands for users to the top. * improve description of the command for the 3.0 release. * Add 'Tools for ...' to make it more readable. --------- Co-authored-by: Sascha L. Teichmann --- README.md | 34 +++++++++++++++++++--------------- 1 file changed, 19 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 09aa3413..6003f702 100644 --- a/README.md +++ b/README.md @@ -2,27 +2,31 @@ An implementation of a [CSAF 2.0](https://docs.oasis-open.org/csaf/csaf/v2.0/csd02/csaf-v2.0-csd02.html) trusted provider, checker, aggregator and downloader. Includes an uploader command line tool for the trusted provider. -## [csaf_provider](docs/csaf_provider.md) -is an implementation of the role CSAF Trusted Provider, also offering -a simple HTTPS based management service. +## Tools for users +### [csaf_downloader](docs/csaf_downloader.md) +is a tool for downloading advisories from a provider. +Can be used for automated forwarding of CSAF documents. -## [csaf_uploader](docs/csaf_uploader.md) -is a command line tool that uploads CSAF documents to the `csaf_provider`. +### [csaf_validator](docs/csaf_validator.md) +is a tool to validate local advisories files against the JSON Schema and an optional remote validator. -## [csaf_aggregator](docs/csaf_aggregator.md) -is an implementation of the role CSAF Aggregator. +## Tools for advisory providers -## [csaf_checker](docs/csaf_checker.md) -is a tool for testing a CSAF Trusted Provider according to [Section 7 of the CSAF standard](https://docs.oasis-open.org/csaf/csaf/v2.0/csaf-v2.0.html#7-distributing-csaf-documents). Does check requirements without considering the indicated `role` yet. +### [csaf_provider](docs/csaf_provider.md) +is an implementation of the role CSAF Trusted Provider, also offering +a simple HTTPS based management service. -## [csaf_downloader](docs/csaf_downloader.md) -is a tool for downloading advisories from a provider. +### [csaf_uploader](docs/csaf_uploader.md) +is a command line tool to upload CSAF documents to the `csaf_provider`. -## [csaf_validator](docs/csaf_validator.md) -is a tool to validate local advisories files against the JSON Schema and an optional remote validator. +### [csaf_checker](docs/csaf_checker.md) +is a tool for testing a CSAF Trusted Provider according to [Section 7 of the CSAF standard](https://docs.oasis-open.org/csaf/csaf/v2.0/csaf-v2.0.html#7-distributing-csaf-documents). + +### [csaf_aggregator](docs/csaf_aggregator.md) +is a CSAF Aggregator, to list or mirror providers. ## Setup -Note that binaries for the server side are only available and tested +Binaries for the server side are only available and tested for GNU/Linux-Systems, e.g. Ubuntu LTS. They are likely to run on similar systems when build from sources. @@ -63,7 +67,7 @@ Binaries will be placed in directories named like `bin-linux-amd64/` and `bin-wi ## License -- csaf_distribution is licensed as Free Software under MIT License. +- `csaf_distribution` is licensed as Free Software under MIT License. - See the specific source files for details, the license itself can be found in the directory `LICENSES/`.