index.ts · cryptotaxi247/js-libp2p-inspector

main

ts 42 lines 1.04 KB

Raw

1	/**
2	* @packageDocumentation
3	*
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	* ![libp2p-inspector running in Electron](https://github.com/ipshipyard/js-libp2p-inspector/blob/main/assets/electron.png?raw=true)
8	*
9	* ## Installation instructions
10	*
11	* ### 1. libp2p configuration
12	*
13	* Configure `@ipshipyard/libp2p-inspector-metrics` as your metrics implementation:
14	*
15	* ```ts
16	* import { createLibp2p } from 'libp2p'
17	* import { inspectorMetrics } from '@ipshipyard/libp2p-inspector-metrics'
18	*
19	* const node = await createLibp2p({
20	* metrics: inspectorMetrics(),
21	* //... other options her
22	* })
23	* ```
24	*
25	* ### 2. Install the inspector
26	*
27	* ```console
28	* $ npm i -g @ipshipyard/libp2p-inspector
29	* ```
30	*
31	* ### 3. Run
32	*
33	* ```console
34	* $ libp2p-inspector
35	* ```
36	*
37	* Local libp2p nodes running the `@ipshipyard/libp2p-inspector-metrics` metrics
38	* implementation will advertise themselves via MDNS and should appear in the
39	* app.
40	*/
41
42	export {}