@coherent.js/devtools 1.1.2 → 2.0.0-rc.0

package/README.md

@@ -2,14 +2,16 @@
 
 [![npm version](https://img.shields.io/npm/v/@coherent.js/devtools.svg)](https://www.npmjs.com/package/@coherent.js/devtools)
 [![license: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](../../LICENSE)
-[![Node >= 20](https://img.shields.io/badge/node-%3E%3D20-brightgreen)](https://nodejs.org)
+[![Node >= 22.12](https://img.shields.io/badge/node-%3E%3D22.12-brightgreen)](https://nodejs.org)
 
 Developer tools for Coherent.js applications: inspector, profiler, and logger utilities.
 
-- ESM-only, Node 20+
+- ESM-only, Node 22.12+
 - Lightweight debugging and profiling helpers
 - Designed to pair with `@coherent.js/core`
 
+**Stability:** development-only tooling. Don't ship it in production bundles or rely on it in production servers: `createDevTools()` is off unless `NODE_ENV=development` (or a localhost page in the browser) or `{ enabled: true }` is passed, and profilers record nothing until enabled.
+
 For a high-level overview and repository-wide instructions, see the root README: ../../README.md
 
 ## Installation
@@ -50,28 +52,30 @@ import { LRUCache, memoize } from '@coherent.js/devtools/performance/cache';
 
 JavaScript (ESM):
 ```js
-import { logger } from '@coherent.js/devtools/logger';
+import { createLogger, LogLevel } from '@coherent.js/devtools/logger';
 import { createProfiler } from '@coherent.js/devtools/profiler';
 
+const logger = createLogger({ level: LogLevel.DEBUG });
 logger.info('Starting app');
 
-const profiler = createProfiler('render');
-profiler.start();
+// Profilers record nothing until enabled
+const profiler = createProfiler({ enabled: true });
+const session = profiler.start('render');
 // ... render work ...
-profiler.stop();
+console.log(profiler.stop(session).duration); // ms, from performance.now()
 ```
 
-TypeScript:
+TypeScript (the declarations ship with the root entry point):
 ```ts
-import { logger } from '@coherent.js/devtools/logger';
-import { createProfiler } from '@coherent.js/devtools/profiler';
+import { createLogger, createProfiler, LogLevel } from '@coherent.js/devtools';
 
+const logger = createLogger({ level: LogLevel.DEBUG });
 logger.debug('Bootstrapping');
 
-const profiler = createProfiler('render');
-profiler.start();
+const profiler = createProfiler({ enabled: process.env.NODE_ENV !== 'production' });
+const session = profiler.start('render');
 // ... work ...
-profiler.stop();
+profiler.stop(session);
 ```
 
 ## Exports