@browser-echo/core - npm Package Compare versions

Comparing version 0.0.6 to 1.0.0

package.json

 {
   "name": "@browser-echo/core",
-  "version": "0.0.6",
+  "version": "1.0.0",
   "type": "module",
@@ -5,0 +5,0 @@ "sideEffects": false,

README.md

@@ -7,2 +7,8 @@ # @browser-echo/core
 
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Install MCP Server](#install-mcp-server)
+
 ## Features
@@ -46,13 +52,27 @@
 
+Most providers accept these options (names may appear as plugin options or component props):
+
 ```ts
-interface InitBrowserEchoOptions {
-  route?: `/${string}`;              // default: '/__client-logs'
+type BrowserLogLevel = 'log' | 'info' | 'warn' | 'error' | 'debug';
+
+interface BrowserEchoOptions {
+  enabled?: boolean;                 // default: true (dev only)
+  route?: `/${string}`;              // default: '/api/client-logs' (Next), '/__client-logs' (others)
   include?: BrowserLogLevel[];       // default: ['log','info','warn','error','debug']
-  preserveConsole?: boolean;         // default: true (also keep logging in browser)
+  preserveConsole?: boolean;         // default: true (also keep logging in the browser)
   tag?: string;                      // default: '[browser]'
+  // stacks
+  stackMode?: 'none' | 'condensed' | 'full'; // default: 'full' (provider-specific; Vite supports all)
+  showSource?: boolean;              // default: true (when available)
+  // batching
   batch?: { size?: number; interval?: number }; // default: 20 / 300ms
-  stackMode?: 'full' | 'condensed' | 'none';    // default: 'condensed'
+  // server-side
+  truncate?: number;                 // default: 10_000 chars (Vite)
+  fileLog?: { enabled?: boolean; dir?: string }; // Vite-only
 }
 ```
 
+> Note: File logging and `truncate` are currently implemented in the Vite plugin's dev server middleware. Nuxt/Next providers print to stdout by default (you can extend them if you need file output there).
+
+
 ## Framework Providers
@@ -70,2 +90,17 @@
 
+## Install MCP Server
+
+For core usage, MCP forwarding depends on your server-side route implementation. The core package only handles browser-side log collection.
+
+**📖 [First, set up the MCP server](../mcp/README.md#installation) for your AI assistant, then configure framework options below.**
+
+### Environment Variables
+
+- `BROWSER_ECHO_MCP_URL=http://127.0.0.1:5179/mcp` — Set in your server environment
+- `BROWSER_ECHO_SUPPRESS_TERMINAL=1` — Control terminal output in your route handler
+
+### Server Route MCP Integration
+
+See the [React MCP Settings](../react/README.md#mcp-settings) for an example server route with MCP forwarding.
+
 ## Author
@@ -72,0 +107,0 @@

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Improved metrics

Total package byte prevSize

11473

15.17%

Number of low quality alerts

1

-50%

Number of lines in readme file

115

43.75%

No dependency changes