braintrust 3.1.0 → 3.2.0

package/README.md

@@ -69,3 +69,76 @@ The `@braintrust/browser` package is optimized for browser environments and incl
 See the [@braintrust/browser README](../integrations/browser-js/README.md) for more details.
 
 **Breaking change in v3.0.0:** The `braintrust/browser` subpath export has been deprecated. Browser users should migrate to the `@braintrust/browser` package.
+
+### Auto-Instrumentation
+
+Braintrust provides automatic instrumentation for popular AI SDKs, eliminating the need for manual wrapping. This feature automatically logs all AI SDK calls (OpenAI, Anthropic, Vercel AI SDK, etc.) to Braintrust without any code changes.
+
+#### Node.js Applications
+
+For Node.js applications, use the `--import` flag to load the instrumentation hook:
+
+```bash
+node --import braintrust/hook.mjs app.js
+```
+
+This works with both ESM and CommonJS modules automatically.
+
+#### Browser/Bundled Applications
+
+For browser applications or bundled Node.js applications, use the appropriate bundler plugin:
+
+**Vite:**
+
+```typescript
+// vite.config.ts
+import { vitePlugin } from "braintrust/vite";
+
+export default {
+  plugins: [vitePlugin()],
+};
+```
+
+**Webpack:**
+
+```javascript
+// webpack.config.js
+const { webpackPlugin } = require("braintrust/webpack");
+
+module.exports = {
+  plugins: [webpackPlugin()],
+};
+```
+
+**esbuild:**
+
+```typescript
+import { esbuildPlugin } from "braintrust/esbuild";
+
+await esbuild.build({
+  plugins: [esbuildPlugin()],
+});
+```
+
+**Rollup:**
+
+```typescript
+import { rollupPlugin } from "braintrust/rollup";
+
+export default {
+  plugins: [rollupPlugin()],
+};
+```
+
+**Important:** If you're using TypeScript or other transpilation plugins, place the Braintrust plugin **after** them in the plugin array to ensure it instruments the transformed code:
+
+```typescript
+export default {
+  plugins: [
+    typescript(), // or other transpilation plugins
+    vitePlugin(), // Braintrust plugin should come after
+  ],
+};
+```
+
+For more information on auto-instrumentation, see the [internal architecture docs](src/auto-instrumentations/README.md).