diff --git a/README.md b/README.md index 649df3b..7fcfed1 100644 --- a/README.md +++ b/README.md @@ -17,12 +17,45 @@ useful. This includes: ## Installation -`spdx3-validate` can be installed using `pip`: +`spdx3-validate` can be installed using either `pip` +or [`pipx`](https://github.com/pypa/pipx): ```shell python3 -m pip install spdx3-validate ``` +or + +```shell +pipx install spdx3-validate +``` + +## Usage + +```shell +spdx3-validate -j sbom.json +``` + +### Options + +All available options can be listed by this command: + +```shell +spdx3-validate -h +``` + +```text +options: + -h, --help show this help message and exit + --json, -j JSON Validate SPDX 3 JSON file (URL, path, or '-') + --spdx-version, -s {3.0.0,3.0.1,auto} + SPDX Version to use, or 'auto' to determine version + from input files + --version, -V show program's version number and exit + --no-merge Do not validate merged documents + --quiet, -q Run quietly (do not show progress) +``` + ## Developing Developing on `spdx3-validate` is best done using a virtual environment. You