Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
prathamgahlout authored Dec 31, 2023
1 parent a6802cd commit 10c1d5a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

A command line tool to scan the dependencies of a project and detect their Licenses. I wrote this while building an SCA Tool.

The tool scans the metadata file (e.g. pom.xml for maven based projects and package.json for npm) and creates a dependency tree by recursively resolving each dependency from respective repositories. The license (if found) is analyzed and matched with the licenses in the SPDX License Database using methods of NLP. The motivation for the algorithm of license detection is taken from [Link](https://github.com/go-enry/go-license-detector).
The tool scans the metadata file (e.g. pom.xml for maven based projects and package.json for npm) and creates a dependency tree detecting the direct as well as transitive dependencies. The license (if found) is analyzed and matched with the licenses in the SPDX License Database using methods of NLP. The motivation for the algorithm of license detection is taken from [Link](https://github.com/go-enry/go-license-detector).

![SAMPLE_IMAGE](./images/npm-scan-result.jpg)

Expand Down Expand Up @@ -36,7 +36,7 @@ The tool scans the metadata file (e.g. pom.xml for maven based projects and pack

## Build

Build the jar package
Build the jar package using Maven
```
mvn -DskipTests package
```
Expand All @@ -48,7 +48,7 @@ To scan a local project
java -jar <path-to-jar> scan -src <project-path>
```

To scan a remote repository/package
To scan a remote repository
```
java -jar <path-to-jar> monitor -src <repo-url>
```
Expand Down

0 comments on commit 10c1d5a

Please sign in to comment.