docs: update readmes
achingbrain committed
May 24, 2025 at 09:31 UTC
54d5e3e731690f682fa4d5ba9e3d456cead09b22
7 files changed
+17
-10
README.md
+1
-1
@@ -8,7 +8,7 @@
8
A web based inspector for libp2p nodes that runs in [browser devtools](https://github.com/ipshipyard/js-libp2p-inspector/tree/main/packages/libp2p-devtools) or as a
9
standalone [Electron app](https://github.com/ipshipyard/js-libp2p-inspector/tree/main/packages/libp2p-inspector).
10
11
-
11
+
12
13
# Packages
14
assets/devtools.png
Binary files /dev/null and b/assets/devtools.png differ
packages/libp2p-devtools/README.md
+3
-3
@@ -26,7 +26,7 @@ A [DevTools](https://developer.chrome.com/docs/devtools) plugin that adds a "lib
26
27
Works with [@ipshipyard/libp2p-inspector-metrics](https://www.npmjs.com/package/@ipshipyard/libp2p-inspector-metrics) which supplies metrics and allows us to interact with the running node.
28
29
-<img width="840" alt="image" src="https://github.com/ipfs-shipyard/js-libp2p-devtools/assets/665810/f8f6a7c8-377f-41d6-948f-95d8469f58b8">
29
+
30
31
## Installation instructions
32
@@ -63,13 +63,13 @@ With the move to Manifest v3, users must now [opt in](https://blog.mozilla.org/a
63
64
Please click the extensions button, then grant the extension permission to run:
65
66
-<img src="public/img/grant-permissions-light-chrome.png" width="700"/>
66
+
67
68
#### Firefox
69
70
Please click the extensions button, then grant the extension permission to run:
71
72
-<img src="public/img/grant-permissions-light-firefox.png" width="700"/>
72
+
73
74
### 4. Go!
75
packages/libp2p-devtools/src/index.ts
+3
-3
@@ -5,7 +5,7 @@
5
*
6
* Works with [@ipshipyard/libp2p-inspector-metrics](https://www.npmjs.com/package/@ipshipyard/libp2p-inspector-metrics) which supplies metrics and allows us to interact with the running node.
7
*
8
- * <img width="840" alt="image" src="https://github.com/ipfs-shipyard/js-libp2p-devtools/assets/665810/f8f6a7c8-377f-41d6-948f-95d8469f58b8">
8
+ * 
9
*
10
* ## Installation instructions
11
*
@@ -41,13 +41,13 @@
41
*
42
* Please click the extensions button, then grant the extension permission to run:
43
*
44
- * <img src="public/img/grant-permissions-light-chrome.png" width="700"/>
44
+ * 
45
*
46
* #### Firefox
47
*
48
* Please click the extensions button, then grant the extension permission to run:
49
*
50
- * <img src="public/img/grant-permissions-light-firefox.png" width="700"/>
50
+ * 
51
*
52
* ### 4. Go!
53
*
packages/libp2p-inspector/README.md
+2
-2
@@ -25,7 +25,7 @@ repo and examine the changes made.
25
An electron app that bundles @ipshipyard/libp2p-inspector-ui for use with
26
libp2p nodes running under Node.js or (eventually) in browsers.
27
28
-
28
+
29
30
## Installation instructions
31
@@ -43,7 +43,7 @@ const node = await createLibp2p({
43
})
44
```
45
46
-### 2. Install the inspector
46
+### 2. Install the inspector
47
48
```console
49
$ npm i -g @ipshipyard/libp2p-inspector
packages/libp2p-inspector/src/index.ts
+1
-1
@@ -4,7 +4,7 @@
4
* An electron app that bundles @ipshipyard/libp2p-inspector-ui for use with
5
* libp2p nodes running under Node.js or (eventually) in browsers.
6
*
7
- * 
7
+ * 
8
*
9
* ## Installation instructions
10
*
typedoc.json
new
+7
@@ -0,0 +1,7 @@
1
+{
2
+ "$schema": "https://typedoc.org/schema.json",
3
+ "name": "@ipshipyard/libp2p-inspector",
4
+ "readme": "./README.md",
5
+ "hideGenerator": true,
6
+ "customFooterHtml": "With ❤️ from <a href='https://ipshipyard.com/' target='_blank' rel='noreferrer'>IP Shipyard</a>"
7
+}