docs: update readmes

Author: achingbrain

README.md

@@ -1,10 +1,15 @@
-# js-libp2p-inspector-monorepo
+# js-libp2p-inspector
 
 [![codecov](https://img.shields.io/codecov/c/github/ipshipyard/js-libp2p-inspector.svg?style=flat-square)](https://codecov.io/gh/ipshipyard/js-libp2p-inspector)
 [![CI](https://img.shields.io/github/actions/workflow/status/ipshipyard/js-libp2p-inspector/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/ipshipyard/js-libp2p-inspector/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
 
 > Inspect a running libp2p node
 
+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
+standalone [Electron app](https://github.com/ipshipyard/js-libp2p-inspector/tree/main/packages/libp2p-inspector).
+
+![libp2p-inspector running in Electron](https://github.com/ipshipyard/js-libp2p-inspector/blob/main/assets/electron.png)
+
 # Packages
 
 - [`packages/libp2p-devtools`](https://github.com/ipshipyard/js-libp2p-inspector/tree/main/packages/libp2p-devtools) Browser DevTools plugin to inspect a libp2p node running on the current page

assets/electron.png

@@ -32,6 +32,7 @@
     "dep-check": "aegir run dep-check",
     "doc-check": "aegir run doc-check",
     "spell-check": "aegir spell-check",
+    "start": "aegir run start",
     "release": "run-s build docs:no-publish npm:release docs",
     "npm:release": "aegir run release --concurrency 1",
     "docs": "aegir docs",

package.json

@@ -101,12 +101,6 @@ Browse to your webapp and open the DevTools, you should see a "libp2p" tab towar
 
 6. ??? more features here
 
-# Install
-
-```console
-$ npm i @ipshipyard/libp2p-devtools
-```
-
 # License
 
 Licensed under either of

packages/libp2p-devtools/README.md

@@ -25,12 +25,40 @@ repo and examine the changes made.
 An electron app that bundles @ipshipyard/libp2p-inspector-ui for use with
 libp2p nodes running under Node.js or (eventually) in browsers.
 
-# Install
+![libp2p-inspector running in Electron](https://github.com/ipshipyard/js-libp2p-inspector/blob/main/assets/electron.png)
+
+## Installation instructions
+
+### 1. libp2p configuration
+
+Configure `@ipshipyard/libp2p-inspector-metrics` as your metrics implementation:
+
+```ts
+import { createLibp2p } from 'libp2p'
+import { inspectorMetrics } from '@ipshipyard/libp2p-inspector-metrics'
+
+const node = await createLibp2p({
+  metrics: inspectorMetrics(),
+  //... other options her
+})
+```
+
+### 2. Install the inspector
+
+```console
+$ npm i -g @ipshipyard/libp2p-inspector
+```
+
+### 3. Run
 
 ```console
-$ npm i @ipshipyard/libp2p-inspector
+$ libp2p-inspector
 ```
 
+Local libp2p nodes running the `@ipshipyard/libp2p-inspector-metrics` metrics
+implementation will advertise themselves via MDNS and should appear in the
+app.
+
 # License
 
 Licensed under either of

packages/libp2p-inspector/README.md

@@ -3,6 +3,40 @@
  *
  * An electron app that bundles @ipshipyard/libp2p-inspector-ui for use with
  * libp2p nodes running under Node.js or (eventually) in browsers.
+ *
+ * ![libp2p-inspector running in Electron](https://github.com/ipshipyard/js-libp2p-inspector/blob/main/assets/electron.png)
+ *
+ * ## Installation instructions
+ *
+ * ### 1. libp2p configuration
+ *
+ * Configure `@ipshipyard/libp2p-inspector-metrics` as your metrics implementation:
+ *
+ * ```ts
+ * import { createLibp2p } from 'libp2p'
+ * import { inspectorMetrics } from '@ipshipyard/libp2p-inspector-metrics'
+ *
+ * const node = await createLibp2p({
+ *   metrics: inspectorMetrics(),
+ *   //... other options her
+ * })
+ * ```
+ *
+ * ### 2. Install the inspector
+ *
+ * ```console
+ * $ npm i -g @ipshipyard/libp2p-inspector
+ * ```
+ *
+ * ### 3. Run
+ *
+ * ```console
+ * $ libp2p-inspector
+ * ```
+ *
+ * Local libp2p nodes running the `@ipshipyard/libp2p-inspector-metrics` metrics
+ * implementation will advertise themselves via MDNS and should appear in the
+ * app.
  */
 
 export {}