Skip to content

Update README.md #21

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

Merged
merged 2 commits into from
Jun 28, 2022
Merged

Update README.md #21

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
14a44ff
Update README.md
hmaurer Jun 28, 2022
5c9df09
Update README.md
hmaurer Jun 28, 2022
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
13 changes: 6 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ outputs). After submission to the API, the included dependencies appear in the
repository's [dependency
graph](https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph).

## Installation

```
npm install @github/dependency-submission-toolkit
```

## Usage

Some useful commands to navigate using the library:
Expand Down Expand Up @@ -58,10 +64,3 @@ also included in a workflow in this repository and run for each commit to the
This library uses the `jest` testing framework with tests co-located with
source files. To run the tests, you can use `npm test` to run tests.
Otherwise you can use `jest` directly.

## Installation

The `dependency-submission-toolkit` library is hosted on GitHub's npm
registry. Follow [the
documentation](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#installing-a-package)
to install the package in your project.