Bug 1390037 - Create readme file; r?rickychien draft
authorJan Odvarko <odvarko@gmail.com>
Wed, 20 Sep 2017 07:54:21 +0200
changeset 667492 dd87e66941a9aff7e3bfa73f245493b7c069a85c
parent 667059 848aaf7cccca09b2eda54ddc5f90ba59e3227a6f
child 732401 3935065c2a7f08bbb5c81ad9da44459a21a55cac
push id80728
push userjodvarko@mozilla.com
push dateWed, 20 Sep 2017 05:55:08 +0000
reviewersrickychien
bugs1390037
milestone57.0a1
Bug 1390037 - Create readme file; r?rickychien MozReview-Commit-ID: GTgvZeYgbtM
devtools/client/netmonitor/src/connector/README.md
new file mode 100644
--- /dev/null
+++ b/devtools/client/netmonitor/src/connector/README.md
@@ -0,0 +1,69 @@
+# Network Monitor
+
+The Network Monitor (netmonitor) can be connected with various back-ends:
+
+* Firefox
+* Chrome
+* NodeJS (planned)
+
+Implementation of particular connectors is located in:
+`mozilla-central/devtools/client/netmonitor/src/connector`
+
+[create a bug report](https://bugzilla.mozilla.org/enter_bug.cgi?product=Firefox&component=Developer%20Tools%3A%20Netmonitor)
+in case of any issues.
+
+See instructions describing how to connect supported back-ends.
+
+## Firefox
+Connecting to Firefox browser.
+
+Navigate to the `mozilla-central/devtools/client/netmonitor` folder with your terminal.
+Then run the following commands:
+
+```bash
+# Install packages
+yarn install
+
+# Run a dev server instance (for hosting netmonitor on browser)
+yarn start
+
+# Run Firefox (with port 6080 opened for connections)
+firefox http://localhost:8000 --start-debugger-server 6080
+```
+
+Finally, load `http://localhost:8000` page in your favorite browser
+(might be the same browser instance you are connecting to)
+
+Read more detailed instructions in:
+`mozilla-central/devtools/client/netmonitor/README.md`
+
+## Chrome
+Connecting to Chrome browser
+
+Navigate to the `mozilla-central/devtools/client/netmonitor` folder with your terminal.
+Then run the following commands:
+
+```bash
+# Install packages
+yarn install
+
+# Run a dev server instance (for hosting netmonitor on browser)
+yarn start
+
+# Run Chrome (with port 9222 opened for connections)
+google-chrome --remote-debugging-port=9222
+```
+
+Finally, load `http://localhost:8000` page in your favorite browser
+
+### Prerequisite
+
+Chrome connector is rely on Chrome DevTools Protocol API version 1.2.
+More details: [stable 1.2 protocol](https://chromedevtools.github.io/devtools-protocol/1-2/)
+
+* [Google Chrome] >= 5.4.x
+
+## NodeJS
+
+TBD
+