Skip to content

Commit c37bcf3

Browse files
authored
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
1 parent a561850 commit c37bcf3

1 file changed

Lines changed: 57 additions & 19 deletions

File tree

README.md

Lines changed: 57 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# OpenSumi DevTools
22

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))
44

55
<table>
66
<thead>
@@ -13,12 +13,12 @@ A Chrome DevTools Extension for any [OpenSumi](https://github.com/opensumi/core)
1313
<tr>
1414
<td>
1515
<img
16-
src="https://user-images.githubusercontent.com/32434520/186371187-dc68ccb0-76d5-4731-8a15-1e122a927931.png"
16+
src="https://user-images.githubusercontent.com/32434520/192236137-fa3495a7-3999-416c-ad59-9a6aa8a2e2d0.png"
1717
/>
1818
</td>
1919
<td>
2020
<img
21-
src="https://user-images.githubusercontent.com/32434520/186371624-675d51f8-429f-4612-89f3-e9ee45f22a1b.png"
21+
src="https://user-images.githubusercontent.com/32434520/192235671-52dfe310-21a6-40f9-8c39-1582daddfc30.png"
2222
/>
2323
</td>
2424
</tr>
@@ -27,34 +27,73 @@ A Chrome DevTools Extension for any [OpenSumi](https://github.com/opensumi/core)
2727

2828
## Features
2929

30-
Currently OpenSumi DevTools focuses on message capturing and presenting:
30+
Currently OpenSumi DevTools focuses on messages capturing and presenting:
3131

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)
3434

3535
Users are allowed to:
3636

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
4442

4543
## Install
4644

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:
62+
63+
```javascript
64+
import { app, session } from 'electron';
65+
import installExtension from 'electron-devtools-installer';
66+
67+
import { ElectronMainApp } from '@opensumi/ide-core-electron-main';
68+
69+
const electronApp = new ElectronMainApp({
70+
...
71+
});
72+
73+
const OPENSUMI_DEVTOOLS_CHROME_WEBSTORE_ID = 'ombdblngipgeakodomcednfdiabohmgl';
74+
75+
electronApp.init().then(() => {
76+
...
77+
app.whenReady().then(() => {
78+
installExtension(OPENSUMI_DEVTOOLS_CHROME_WEBSTORE_ID);
79+
});
80+
});
81+
```
82+
3. Open DevTools in your app and you will see it!
83+
84+
### Option 2: Install from a folder
85+
86+
In the following way, users can install other versions of OpenSumi DevTools except for the one that published in Chrome webstore.
4887

49-
**Web**
88+
**Web client**
5089

5190
1. Download `opensumi-devtools-vx.x.x.zip` from [releases](https://github.com/opensumi/devtools/releases)
5291
2. Unzip it and get a folder
5392
3. Vist chrome [extensions](chrome://extensions/) page and check "Developer mode"
5493
4. Click "Load unpacked extension" and select the folder
55-
5. Open DevTools in your page and have fun!
94+
5. Open DevTools in your page and you will see it!
5695

57-
**Electron**
96+
**Electron client**
5897

5998
1. Download `opensumi-devtools-vx.x.x.zip` from [releases](https://github.com/opensumi/devtools/releases)
6099
2. Unzip it and get a folder
@@ -74,9 +113,8 @@ electronApp.init().then(() => {
74113
session.defaultSession.loadExtension(opensumiDevtoolsPath);
75114
});
76115
```
77-
4. Open DevTools in your app and have fun!
116+
4. Open DevTools in your app and you will see it!
78117

79-
Things will get easier after we publish the extension to chrome store. Stay tuned!
80118
## Contributing
81119

82120
Please read [CONTRIBUTING](./CONTRIBUTING.md) if you are new here or not familiar with the basic rules of Git/GitHub world.

0 commit comments

Comments
 (0)