diff --git a/README.md b/README.md index 08c381d..144d3e1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ +
+ +
+ + # Phsyberdome Dependency Scanner And License Detector A command line tool written in Java to scan the dependencies of a project and detect their Licenses. I wrote this while building an SCA Tool. @@ -6,7 +11,6 @@ The tool scans the metadata file (e.g. pom.xml for maven based projects and pack ![SAMPLE_IMAGE](./images/npm-scan-result.jpg) -## TODO ### Features @@ -40,7 +44,17 @@ mvn -DskipTests package ## Usage To scan a local project -`java -jar scan -src ` +``` +java -jar scan -src +``` To scan a remote repository/package -`java -jar monitor -src ` +``` +java -jar monitor -src +``` + +## CONTRIBUTING + +Contributions are always welcome. Help me make this software bug free, robust and support more package managers. +Please feel free to raise an issue and discuss. + diff --git a/images/logo.png b/images/logo.png new file mode 100644 index 0000000..eff2032 Binary files /dev/null and b/images/logo.png differ diff --git a/images/logo_org.png b/images/logo_org.png new file mode 100644 index 0000000..7689d93 Binary files /dev/null and b/images/logo_org.png differ