Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
edoardottt committed Jul 29, 2023
1 parent 2b4d5f4 commit 0a7518a
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,13 @@ Install 📡
----------

### Using Snap

```bash
sudo snap install depsdev
```

### Using Go

```
go install github.com/edoardottt/depsdev@latest
```
Expand Down Expand Up @@ -71,7 +73,7 @@ Flags:
Use "depsdev [command] --help" for more information about a command.
```

Examples :bulb:
Examples :bulb
----------

> **Note**
Expand All @@ -81,48 +83,55 @@ For more information [read the API documentation](https://docs.deps.dev/api/v3al
<br>

Get information about a package, including a list of its available versions, with the default version marked if known.

```console
depsdev info npm @colors/colors
```

<br>

Get information about a specific package version including its licenses and any security advisories known to affect it.

```console
depsdev info npm @colors/colors 1.5.0
```

<br>

Get information about a resolved dependency graph for the given package version.

```console
depsdev deps npm @colors/colors 1.5.0
```

<br>

Get information about projects hosted by GitHub, GitLab, or BitBucket (if available).

```console
depsdev project github.com/facebook/react
```

<br>

Get information about security advisories hosted by OSV.

```console
depsdev advisory GHSA-2qrg-x229-3v8q
```

<br>

Get information about multiple package versions, which can be specified by name, content hash, or both.

```console
depsdev query "versionKey.system=NPM&versionKey.name=react&versionKey.version=18.2.0"
```

<br>

Generate a Graphviz compatible dependencies graph for a specific version of a package.

```console
depsdev graph npm slice-ansi 6.0.0
```
Expand All @@ -140,7 +149,7 @@ import (
func main() {
i, err := depsdev.GetInfo("npm", "defangjs")
if err != nil {
fmt.Println(err)
fmt.Println(err)
}

fmt.Println(i)
Expand All @@ -149,6 +158,7 @@ func main() {

Changelog 📌
-------

Detailed changes for each release are documented in the [release notes](https://github.com/edoardottt/depsdev/releases).

Contributing 🛠
Expand All @@ -157,9 +167,11 @@ Contributing 🛠
Just open an [issue](https://github.com/edoardottt/depsdev/issues) / [pull request](https://github.com/edoardottt/depsdev/pulls).

Before opening a pull request, download [golangci-lint](https://golangci-lint.run/usage/install/) and run

```console
golangci-lint run
```

If there aren't errors, go ahead :)

The HTTP client implementation is partially taken from [@liamg/hackerone](https://github.com/liamg/hackerone).
Expand Down

0 comments on commit 0a7518a

Please sign in to comment.