Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Docker Version to Installation Instructions #187

Merged
merged 1 commit into from
Jun 3, 2024
Merged

Add Docker Version to Installation Instructions #187

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ As defined by the NTIA, the minimum elements are "the essential pieces that supp

## Installation

To install use the following command:
*Installation Method #1*: Install from the [Python Package Index (PyPI)](https://pypi.org/project/ntia-conformance-checker/) with `pip`.

`pip install ntia-conformance-checker`

Alternatively, just clone the repo and install dependencies using the following commands:
*Installation Method #2*: Install locally. Clone the repo and install dependencies using the following commands:

```bash
git clone https://github.com/spdx/ntia-conformance-checker.git
Expand All @@ -37,6 +37,20 @@ if you are using different versions of python. `virtualenv` is a tool for settin
allows you to have all the dependencies for the tool set up in a single environment, or have different environments set
up for testing using different versions of Python.

*Installation Method #3*: Users comfortable with containers, specifically Docker, can also pull a container that includes `ntia-conformance-checker`.

One version is hosted on [Chainguard's registry](https://images.chainguard.dev/directory/image/ntia-conformance-checker/overview):

```
docker pull cgr.dev/chainguard/ntia-conformance-checker:latest
```

Another version is hosted on [Docker Hub](https://hub.docker.com/r/chainguard/ntia-conformance-checker):

```
docker pull chainguard/ntia-conformance-checker:latest
```

## CLI Usage

```
Expand Down
Loading