edge-diagnostics-adapter - npm Package Compare versions

Comparing version 0.0.1 to 0.1.0

package.json

 {
   "name": "edge-diagnostics-adapter",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Microsoft Edge Diagnostics Adapter",
@@ -17,2 +17,2 @@ "files": [
   "license": "MIT"
-}
+}

README.md

@@ -5,67 +5,33 @@ # Edge Diagnostics Adapter
 
-**We are aiming to release a binary of the EdgeDiagnosticsAdapter within the next coming weeks, in addition to our Edge Debugger for VSCode.**
-
 ## Installation
-*Release coming soon.*
 
-## Running
+For now we provide binaries on our [releases page](https://github.com/Microsoft/EdgeDiagnosticsAdapter/releases) and via NPM.
 
-1. Launch Edge and browse to the site you want to debug 
-2. Run the EdgeDiagnosticsAdapter.exe
-3. Go to `http://localhost:9222/`
+#### Install via NPM
+```npm install edge-diagnostics-adapter```
 
+Binary is now located in` ./node_modules/edge-diagnostics-adapter/dist/<platform>`
+
+## Usage
+
+```console
+./<path>/EdgeDiagnosticsAdaptor.exe
+```
+
+* `--launch <url>` for opening Edge with a specific URLt.
+* `Ctrl-C` to quit. Also, the adaptor can be left running as a background process.
+
+
+#### Usage via node.
+To simplify usage with Node we are also providing [edge-diagnostics-launch](https://github.com/Microsoft/edge-diagnostics-launch), that works a simple wrapper for the Edge Diagnostics Adapter.
+
+#### View and inspect debuggable targets
+
+Navigate to [localhost:9222](http://localhost:9222). You'll see a listing of all debuggable targets.
+
 ## Supported features and API
 
-| Area  | Method    |
-|-------|-----------|
-|  DOM  | getDocument
-|  DOM  | getAttributes
-|  DOM  | hideHighlight
-|  DOM  | highlightNode
-|  DOM  | setInspectModeEnabled
-|  DOM  | requestChildNodes
-|  DOM  | pushNodesByBackendIdsToFrontend
-|  DOM  | pushNodeByPathToFrontend
-|  DOM  | pushNodeByPathToFrontend
-|  CSS  | getInlineStylesForNode
-|  CSS  | getMatchedStylesForNode
-|  CSS  | getComputedStyleForNode
-|  CSS  | getStyleSheetText
-|  CSS  | setPropertyText
-|  Page | enable
-|  Page | reload
-|  Page | navigate
-|  Page | getCookies
-|  Page | getResourceTree
-|  Page | getAnimationsPlaybackRate
-|  Page | getNavigationHistory
-|  Page | deleteCookie
-|  Page | setOverlayMessage
-|  Page | canScreencast
-|  Page | canEmulate
-|  Page | screencastFrameAck
-|  Page | startRecordingFrames
-|  Page | stopRecordingFrames
-|  Page | startScreencast
-|  Page | stopScreencast
-|  Page | setShowViewportSizeOnResize
-| Runtime | enable
-| Runtime | evaluate
-| Runtime | callFunctionOn
-| Runtime | getProperties
-| Script | canSetScriptSource
-| Script | disable
-| Script | enable
-| Script | evaluateOnCallFrame
-| Script | getScriptSource
-| Script | removeBreakpoint
-| Script | pause
-| Script | resume
-| Script | setBreakpointByUrl
-| Script | stepInto
-| Script | stepOut
-| Script | stepOver
+See [supported features and API](https://github.com/Microsoft/EdgeDiagnosticsAdapter/wiki/Supported-features-and-API) or download the [protocol.json]().
 
-
 ## Building & Contributing
 To build and contribute to this project take a gander at the wiki pages on [building](https://github.com/Microsoft/EdgeDiagnosticsAdapter/wiki/Building) and contributing (coming soon).

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

10562001

decreased by-0.01%

Number of lines in readme file

37

decreased by-47.89%

No dependency changes