You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update README for the new IPC view and a new way for installation (#14)
* docs: update README for the new IPC view and a new way to install the extension
* docs: small changes in README
* docs: improve "install" part of README
* docs: update a link to opensumi.com
* docs: add gif demo link
* docs: fix typos
Copy file name to clipboardExpand all lines: README.md
+57-19Lines changed: 57 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# OpenSumi DevTools
2
2
3
-
A Chrome DevTools Extension for any [OpenSumi](https://github.com/opensumi/core) based IDE.
3
+
A Chrome DevTools Extension for any [OpenSumi](https://github.com/opensumi/core) based IDE. (see [Demo](https://user-images.githubusercontent.com/32434520/192297610-208f1332-76cd-4776-b75c-53981dfd1eb1.gif))
4
4
5
5
<table>
6
6
<thead>
@@ -13,12 +13,12 @@ A Chrome DevTools Extension for any [OpenSumi](https://github.com/opensumi/core)
@@ -27,34 +27,73 @@ A Chrome DevTools Extension for any [OpenSumi](https://github.com/opensumi/core)
27
27
28
28
## Features
29
29
30
-
Currently OpenSumi DevTools focuses on message capturing and presenting:
30
+
Currently OpenSumi DevTools focuses on messages capturing and presenting:
31
31
32
-
-[x]OpenSumi RPC messages
33
-
-[ ] Electron IPC messages (working on it...)
32
+
-[x] RPC messages between frontend and backend
33
+
-[x]IPC messages between Electron processes (Electron client only)
34
34
35
35
Users are allowed to:
36
36
37
-
-[x] toggle capturing
38
-
-[x] filter messages
39
-
-[x] viewing parsed messages
40
-
-[x] detect message netspeed
41
-
-[x] detect network latency
42
-
-[ ] ...
43
-
37
+
-[x] Toggle capturing
38
+
-[x] Filter messages
39
+
-[x] View parsed messages
40
+
-[x] Check communication traffic
41
+
-[x] Check network latency
44
42
45
43
## Install
46
44
47
-
Before we publish it to chrome webstore, you can install OpenSumi DevTools in your OpenSumi based Web/Electron IDE by steps below:
45
+
> IMPORTANT: The devtools supports must be [enabled](https://opensumi.com/en/docs/integrate/browser-extension/opensumi-devtools#integrate) in OpenSumi first, otherwise this extension won't work!
46
+
47
+
Users can install OpenSumi DevTools either from **Chrome webstore** or from **a local folder**.
48
+
49
+
### Option 1: Install from Chrome webstore
50
+
51
+
This way is easier and more recommended.
52
+
53
+
**Web client**
54
+
55
+
1. Visit the extension in [Chrome webstore](https://chrome.google.com/webstore/detail/opensumi-devtools/ombdblngipgeakodomcednfdiabohmgl) and install it to your browser
56
+
2. Open DevTools in your page and you will see it!
57
+
58
+
**Electron client**
59
+
60
+
1. Install [electron-devtools-installer](https://www.npmjs.com/package/electron-devtools-installer) to your project
61
+
2. In your Electron app's entry point do similar things like below:
0 commit comments