Skip to content

Commit 72b3796

Browse files
committed
docs: update web store readme
1 parent 803b16a commit 72b3796

File tree

2 files changed

+17
-28
lines changed

2 files changed

+17
-28
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ A minimal, tabbed web browser with support for Chrome extensions—built on Elec
66

77
## Packages
88

9-
| Name | Description |
10-
| --- | --- |
11-
| [shell](./packages/shell) | A minimal, tabbed web browser used as a testbed for development of Chrome extension support. |
12-
| [electron-chrome-extensions](./packages/electron-chrome-extensions) | Adds additional API support for Chrome extensions to Electron. |
13-
| [electron-chrome-context-menu](./packages/electron-chrome-context-menu) | Chrome context menu for Electron browsers. |
14-
| [electron-chrome-web-store](./packages/electron-chrome-web-store) | Download extensions from the Chrome Web Store in Electron. |
9+
| Name | Description |
10+
| ----------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
11+
| [shell](./packages/shell) | A minimal, tabbed web browser used as a testbed for development of Chrome extension support. |
12+
| [electron-chrome-extensions](./packages/electron-chrome-extensions) | Adds additional API support for Chrome extensions to Electron. |
13+
| [electron-chrome-context-menu](./packages/electron-chrome-context-menu) | Chrome context menu for Electron browsers. |
14+
| [electron-chrome-web-store](./packages/electron-chrome-web-store) | Download extensions from the Chrome Web Store in Electron. |
1515

1616
## Usage
1717

@@ -39,16 +39,17 @@ Load unpacked extensions into `./extensions` then launch the browser.
3939
- [x] Initial [extension popup](https://developer.chrome.com/extensions/browserAction) support
4040
- [x] .CRX extension loader
4141
- [x] [Chrome Web Store](https://chromewebstore.google.com) extension installer
42-
- [ ] [Manifest V3](https://developer.chrome.com/docs/extensions/mv3/intro/) support
42+
- [x] Automatic extension updates
43+
- [ ] [Manifest V3](https://developer.chrome.com/docs/extensions/mv3/intro/) support—pending [electron/electron#44411](https://github.com/electron/electron/pull/44411)
4344
- [ ] Support for common [`chrome.*` extension APIs](https://developer.chrome.com/extensions/devguide)
4445
- [ ] Robust extension popup support
4546
- [ ] Respect extension manifest permissions
4647

4748
### 🤞 Eventually
49+
4850
- [ ] Extension management (enable/disable/uninstall)
4951
- [ ] Installation prompt UX
5052
- [ ] [Microsoft Edge Add-ons](https://microsoftedge.microsoft.com/addons/Microsoft-Edge-Extensions-Home) extension installer
51-
- [ ] Automatic extension updates
5253
- [ ] Full support of [`chrome.*` extension APIs](https://developer.chrome.com/extensions/devguide)
5354

5455
### 🤔 Considering

packages/electron-chrome-web-store/README.md

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,19 @@ Install and manage Chrome extensions from the Chrome Web Store.
88
const { app, BrowserWindow, session } = require('electron')
99
const { installChromeWebStore } = require('electron-chrome-web-store')
1010

11-
async function main() {
12-
await app.whenReady()
13-
11+
app.whenReady().then(async () => {
1412
const browserSession = session.defaultSession
1513
const browserWindow = new BrowserWindow({
1614
webPreferences: {
1715
session: browserSession,
1816
},
1917
})
2018

21-
installChromeWebStore({ session: browserSession })
19+
// Install Chrome web store and wait for extensions to load
20+
await installChromeWebStore({ session: browserSession })
2221

2322
browserWindow.loadURL('https://chromewebstore.google.com/')
24-
}
25-
26-
main()
23+
})
2724
```
2825

2926
To enable full support for Chrome extensions in Electron, install [electron-chrome-extensions](https://www.npmjs.com/package/electron-chrome-extensions).
@@ -37,7 +34,8 @@ Installs Chrome Web Store support in the specified session.
3734
- `options`: An object with the following properties:
3835
- `session`: The Electron session to enable the Chrome Web Store in. Defaults to `session.defaultSession`.
3936
- `modulePath`: The path to the 'electron-chrome-web-store' module.
40-
- `extensionsPath`: The path to the extensions directory. Defaults to 'Extensions/' under the app's userData path.
37+
- `extensionsPath`: The path to the extensions directory. Defaults to 'Extensions/' in the app's userData path.
38+
- `autoUpdate`: Whether to auto-update web store extensions at startup and once every 5 hours. Defaults to true.
4139
- `loadExtensions`: A boolean indicating whether to load extensions installed by Chrome Web Store. Defaults to true.
4240
- `allowUnpackedExtensions`: A boolean indicating whether to allow loading unpacked extensions. Only loads if `loadExtensions` is also enabled. Defaults to false.
4341
- `allowlist`: An array of allowed extension IDs to install.
@@ -52,18 +50,8 @@ Loads all extensions from the specified directory.
5250
- `options`: An object with the following property:
5351
- `allowUnpacked`: A boolean indicating whether to allow loading unpacked extensions. Defaults to false.
5452

55-
> [!NOTE] \
56-
> `installChromeWebStore` will automatically load installed extensions as long as the `loadExtensions` property is set to `true`.
57-
58-
### `downloadExtension`
59-
60-
Downloads an extension from the Chrome Web Store to the specified destination directory.
61-
62-
- `extensionId`: The ID of the extension to download.
63-
- `destDir`: The destination directory where the extension will be downloaded. The directory is expected to exist.
64-
65-
> [!TIP]
66-
> This API is designed to work in Node or Electron.
53+
> [!NOTE]
54+
> The `installChromeWebStore` API will automatically load web store extensions by default.
6755
6856
## License
6957

0 commit comments

Comments
 (0)