Add DEBUG=* debugging guide to readme (#622)

CONTRIBUTING.md

@@ -127,21 +127,5 @@ npm run coverage
 ```
 
 ## Debugging Puppeteer
-Puppeteer uses [DEBUG](https://github.com/visionmedia/debug) module to expose some of it's inner guts under the `puppeteer` namespace. Try putting the following in a file called `script.js` and running it via `DEBUG=* node script.js`:
+See [Debugging Tips](README.md#debugging-tips) in the readme
 
-```js
-const puppeteer = require('puppeteer');
-
-(async () => {
-  const browser = await puppeteer.launch();
-  const page = await browser.newPage();
-  await page.goto('https://example.com');
-  browser.close();
-})();
-```
-
-Tips-n-tricks:
-- `DEBUG=*:session node script.js` - dump protocol session messages (protocol messages to targets)
-- `DEBUG=*,-*:protocol node script.js` - dump everything BUT protocol messages
-- `DEBUG=*:page node script.js` - dump only Page's API calls
-- `DEBUG=*:mouse,*:keyboard node script.js` - dump only Mouse and Keyboard API calls

README.md

@@ -147,19 +147,35 @@ Explore the [API documentation](docs/api.md) and [examples](https://github.com/G
     });
     ```
 
-2. Capture console output from the page by listening for the `console` event.
+1. Capture console output - You can listen for the `console` event.
    This is also handy when debugging code in `page.evaluate()`:
 
     ```js
-    page.on('console', (...args) => {
+    page.on('console', (...args) => console.log('PAGE LOG:', ...args));
-      console.log('PAGE LOG:', ...args);
-    });
 
-    await page.evaluate(() => {
+    await page.evaluate(() => console.log(`url is ${location.href}`));
-      console.log(`url is ${location.href}`);
-    });
     ```
 
+
+1. Enable verbose logging - All public API calls and internal protocol traffic
+   will be logged via the [`debug`](https://github.com/visionmedia/debug) module.
+
+   ```sh
+   # Basic verbose logging
+   env DEBUG="*" node script.js
+
+   # Debug output can be enabled/disabled by namespace
+   env DEBUG="*,-*:protocol" node script.js # everything BUT protocol messages
+   env DEBUG="*:session" node script.js # protocol session messages (protocol messages to targets)
+   env DEBUG="*:mouse,*:keyboard" node script.js # only Mouse and Keyboard API calls
+
+   # Protocol traffic can be rather noisy. This example filters out all Network domain messages
+   env DEBUG="*" env DEBUG_COLORS=true node script.js 2>&1 | grep -v '"Network'
+   ```
+
+
+
+
 ## Contributing to Puppeteer
 
 Check out [contributing guide](https://github.com/GoogleChrome/puppeteer/blob/master/CONTRIBUTING.md) to get an overview of Puppeteer development.