launcher: clarify priority of chromePath options

GoogleChrome · Aug 14, 2017 · 494f991 · 494f991
1 parent 7fe3574
commit 494f991
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/chrome-launcher/README.md b/chrome-launcher/README.md
@@ -41,9 +41,10 @@ npm install chrome-launcher
   handleSIGINT: boolean;
 
   // (optional) Explicit path of intended Chrome binary
-  // If the `CHROME_PATH` env variable is set, that will be used
-  // Usage of `LIGHTHOUSE_CHROMIUM_PATH` env variable is deprecated
-  // By default, any detected Chrome Canary or Chrome (stable) will be launched
+  // * If this `chromePath` option is defined, it will be used.
+  // * Otherwise, the `CHROME_PATH` env variable will be used if set. (`LIGHTHOUSE_CHROMIUM_PATH` is deprecated)
+  // * Otherwise, a detected Chrome Canary will be used if found
+  // * Otherwise, a detected Chrome (stable) will be used
   chromePath: string;
 
   // (optional) Chrome profile path to use