set as optional package

F5Networks · Jun 13, 2019 · b29baa7 · b29baa7
1 parent a5d2b96
commit b29baa7
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 29 deletions.
diff --git a/diagrams/README.md b/diagrams/README.md
@@ -4,7 +4,8 @@ This project makes use of [mermaid](https://mermaidjs.github.io) for diagrams fo
 
 ## Usage
 
+Note: Install by running `npm install` at the root of this project.
+
 ```bash
-npm install
-mmdc -i src/object_model_by_cloud.mmd -o artifacts/object_model_by_cloud.png --theme dark
+./node_modules/.bin/mmdc -i src/object_model_by_cloud.mmd -o artifacts/object_model_by_cloud.png --theme dark
 ```
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -46,7 +46,9 @@
         "icrdk": "git://github.com/f5devcentral/f5-icontrollx-dev-kit#master",
         "mocha": "^5.2.0",
         "nyc": "^14.0.0",
-        "ssh2": "^0.8.2",
+        "ssh2": "^0.8.2"
+    },
+    "optionalDependencies": {
         "mermaid.cli": "^0.5.1"
     },
     "eslintConfig": {