Skip to content
This repository was archived by the owner on May 23, 2025. It is now read-only.

Commit 5c59593

Browse files
authored
docs: update README.md installation instructions (#12)
1 parent 8323680 commit 5c59593

File tree

1 file changed

+22
-9
lines changed

1 file changed

+22
-9
lines changed

README.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,17 @@ Works with [@libp2p/devtools-metrics](https://www.npmjs.com/package/@libp2p/devt
1010

1111
## Installation instructions
1212

13-
1. Browser installation
13+
### 1. Browser installation
1414

1515
Until this plugin is published on the relevant browser plugin stores, please run this locally.
1616

17-
- Chrome: [How to load an unpacked extension](https://knowledge.workspace.google.com/kb/load-unpacked-extensions-000005962)
18-
- Firefox: [How to install temporary add-ons](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Your_first_WebExtension#installing)
17+
1. Clone this repo
18+
2. Run `npm i && npm run build`
19+
3. Install as an unpacked/temporary add on for your browser:
20+
- Chrome: [How to load an unpacked extension](https://knowledge.workspace.google.com/kb/load-unpacked-extensions-000005962)
21+
- Firefox: [How to install temporary add-ons](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Your_first_WebExtension#installing)
1922

20-
2. App installation
23+
### 2. App installation
2124

2225
Configure `@libp2p/devtools-metrics` as your metrics implementation:
2326

@@ -31,15 +34,25 @@ const node = await createLibp2p({
3134
})
3235
```
3336

34-
3. That's it! Browse to your webapp and open the DevTools, you should see a "libp2p" tab towards the right hand side of the toolbar. Click it to see stats about the running node.
37+
### 3. Permissions
3538

36-
## Running on Firefox
39+
With the move to Manifest v3, users must now [opt in](https://blog.mozilla.org/addons/2022/11/17/unified-extensions-button-and-how-to-handle-permissions-in-manifest-v3/) to running content scripts on a page.
3740

38-
With the move to Manifest v3, users must now opt in to running content scripts on a page.
41+
#### Chrome
3942

40-
This tiny green dot shows that granting permissions is required:
43+
Please click the extensions button, then grant the extension permission to run:
4144

42-
More info: https://blog.mozilla.org/addons/2022/11/17/unified-extensions-button-and-how-to-handle-permissions-in-manifest-v3/
45+
<img src="public/img/grant-permissions-light-chrome.png" width="700"/>
46+
47+
#### Firefox
48+
49+
Please click the extensions button, then grant the extension permission to run:
50+
51+
<img src="public/img/grant-permissions-light-firefox.png" width="700"/>
52+
53+
### 4. Go!
54+
55+
Browse to your webapp and open the DevTools, you should see a "libp2p" tab towards the right hand side of the toolbar. Click it to see stats about the running node.
4356

4457
## What's next?
4558

0 commit comments

Comments
 (0)