ソースを参照

Adding install instructions to README

bodicsek 4 年 前
コミット
0f53a91657
1 ファイル変更5 行追加1 行削除
  1. 5 1
      README.md

+ 5 - 1
README.md

@@ -2,7 +2,11 @@
 
 
 This tool's main purpose is to scan an npm project's dependency tree for Oracle Open Source Compliance.  
 This tool's main purpose is to scan an npm project's dependency tree for Oracle Open Source Compliance.  
 
 
-Hence if you run it with the single required parameter `--package` then the result is (only packages eligible for compliance are shown):
+## Install
+1. Download and install nodejs from https://nodejs.org (LTS version is preferred).
+2. `npm install -g --registry https://npm.bodicsek.host @os-tools/npm-dependency-tree`
+## Usage
+If you run it with the single required parameter `--package` then the result is (only packages eligible for compliance are shown):
 ```
 ```
 $ npm-dependency-tree --package ./package.json 
 $ npm-dependency-tree --package ./package.json