Skip to content

Commit 15c8b90

Browse files
Update README.md
1 parent a23f92e commit 15c8b90

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ cd dd-dependency-sniffer
2525

2626
## Usage
2727

28+
First ensure that you have the following software installed on your system:
29+
1. [Docker](https://docs.docker.com/engine/install/)
30+
2. [Bash](https://www.gnu.org/software/bash/)
31+
2832
The sniffer is capable of parsing and analyzing dependency tree reports from
2933
both [Maven](https://maven.apache.org/plugins/maven-dependency-plugin/tree-mojo.html)
3034
and [Gradle](https://docs.gradle.org/current/userguide/viewing_debugging_dependencies.html). It relies on the following
@@ -33,12 +37,20 @@ environment variables to provide access to your local dependencies:
3337
- **_M2_HOME_** (by default `$HOME/.m2`) pointing to your local Maven repository.
3438
- **_GRADLE_USER_HOME_** (by default `$HOME/.gradle`) pointing to your local Gradle repository.
3539

36-
You can run the script via the command line:
40+
You can download the provided script and run it:
3741

3842
```shell
43+
curl "https://datadoghq.dev/dd-dependency-sniffer/run.sh" -o run.sh
44+
chmod +x ./run.sh
3945
./run.sh --type [gradle|maven] --artifact $ARTIFACT_ID --package $PACKAGE_NAME $REPORT
4046
```
4147

48+
Or run it directly with:
49+
50+
```shell
51+
curl -s "https://datadoghq.dev/dd-dependency-sniffer/run.sh" | bash -s -- --type [gradle|maven] --artifact $ARTIFACT_ID --package $PACKAGE_NAME $REPORT
52+
```
53+
4254
The options are as follows:
4355

4456
- **_--type_**: Specify either `gradle` or `maven`.
@@ -63,7 +75,7 @@ report, from your project run:
6375
Run the script:
6476

6577
```shell
66-
./run.sh --type maven --artifact slf4j-api maven.json
78+
run.sh --type maven --artifact slf4j-api maven.json
6779
```
6880

6981
### Gradle
@@ -79,5 +91,5 @@ from your project run:
7991
Run the script:
8092

8193
```shell
82-
./run.sh --type gradle --artifact slf4j-api gradle.txt
94+
run.sh --type gradle --artifact slf4j-api gradle.txt
8395
```

0 commit comments

Comments
 (0)