@prisma/extension-optimize 0.0.0-dev.202408252347 → 0.0.0-dev.202408260920

package/README.md

@@ -13,26 +13,19 @@ Prisma is leading Data DX, a philosophy that promotes simplicity in data-driven
 
 ## Getting started with Prisma Optimize
 
-### Resources
+Enabling Prisma Optimize in your local development workflow is really simple.
 
-You can explore Optimize with the following resources:
+### 1. Install the extension
 
-- [Get started](https://pris.ly/optimize/r/getting-started)
-- [Documentation](https://pris.ly/d/optimize)
-- [Prisma Data Platform](https://console.prisma.io/login?utm_source=github&utm_medium=optimize-readme)
-
-### Using Optimize
-
-#### 1. Launch Optimize
-
-1. Log in to your [Prisma Data Platform](https://console.prisma.io/login?utm_source=github&utm_medium=optimize-readme) account.
-2. Access and launch the Optimize dashboard by following the instructions here.
+```
+npm install @prisma/extension-optimize --save-dev
+```
 
-#### 2. Add Optimize to your application
+> Starting a Prisma ORM project from scratch? Follow https://www.prisma.io/docs/getting-started
 
-##### 2.1. Update Your schema.prisma file
+### 2. Enable the `tracing` preview feature in your Prisma schema
 
-Prisma Optimize uses [Prisma ORM's OpenTelemetry tracing functionality](https://www.prisma.io/docs/orm/prisma-client/observability-and-logging/opentelemetry-tracing). In the `generator` block of your Prisma schema, add the tracing preview feature:
+Prisma Optimize uses [Prisma ORM's OpenTelemetry tracing functionality](https://www.prisma.io/docs/orm/prisma-client/observability-and-logging/opentelemetry-tracing). Enabled it in your Prisma schema:
 
 ```diff
  generator client {
@@ -41,53 +34,37 @@ Prisma Optimize uses [Prisma ORM's OpenTelemetry tracing functionality](https://
  }
 ```
 
-Then, generate the Prisma Client:
-
-```shell
-npx prisma generate
-```
-
-##### 2.2. Install the Optimize Prisma Client extension
-
-Install the latest versions of Prisma Client and the Optimize extension:
+After enabling the `tracing` preview feature, you need to re-generate your Prisma Client:
 
-```shell
-npm install @prisma/client@latest @prisma/extension-optimize
 ```
-
-##### 2.3. Create an API Key via Optimize's UI and add it to your .env file
-
-Generate an Optimize API key by following the instructions [here](https://pris.ly/optimize/r/api-token-generation) and add it to your .env file:
-
-```env
-OPTIMIZE_API_KEY="YOUR_OPTIMIZE_API_KEY"
+npx prisma generate
 ```
 
-##### 2.4. Extend your Prisma Client instance with the Optimize extension
-
-Extend your existing Prisma Client instance with the Optimize extension:
+### 3. Extend your Prisma Client with Prisma Optimize support
 
 ```typescript
 import { PrismaClient } from "@prisma/client";
 import { withOptimize } from "@prisma/extension-optimize";
 
-const prisma = new PrismaClient().$extends(withOptimize({ token: process.env.OPTIMIZE_API_KEY }));
+const prisma = new PrismaClient().$extends(withOptimize());
 ```
 
-##### 2.5. Use Prisma Optimize to generate insights
-
-Follow these steps to start generating query insights with Prisma Optimize:
-
-1. In the Optimize dashboard, click the Start recording button, then run your app.
-
-2. After your app runs and insights are generated for the desired queries, click the Stop recording button.
-
-3. Explore individual query details by clicking on them, and check the Recommendations tab for any suggested improvements to enhance query performance.
+The extension will orchestrate the user experience around Prisma Optimize. When running your app, you will:
 
-> **_NOTE:_** Use the [AI Explainer](https://pris.ly/optimize/r/ai-explainer) feature to understand recommendations and apply them within your Prisma model context.
+- Be required to log into the Prisma Data Platform through your GitHub account
+- And be instructed to visit the URL of your Optimize dashboard:
 
-For a hands-on learning experience, try out the [step-by-step example](https://github.com/prisma/prisma-examples/optimize/starter).
+  ```terminal
+  $ tsx index.ts
+  
+  ┌─────────────────────────────────┐
+  │ See your Optimize dashboard at: │
+  │ https://optimize.prisma.io/     │
+  └─────────────────────────────────┘
+  
+  [...]
+  ```
 
-### Need help?
+## Got feedback?
 
-If you need assistance, reach out in the #help-and-questions channel on our [Discord](https://pris.ly/discord), or connect with our community to see how others are using Optimize.
+Please [submit an issue](https://github.com/prisma/optimize-feedback/issues/new/choose) or [join a discussion](https://github.com/prisma/optimize-feedback/discussions) in our [feedback repository](https://github.com/prisma/optimize-feedback/)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prisma/extension-optimize",
-  "version": "0.0.0-dev.202408252347",
+  "version": "0.0.0-dev.202408260920",
   "sideEffects": false,
   "description": "",
   "main": "./dist/index.js",
@@ -28,7 +28,7 @@
     "hono": "4.4.6",
     "tsup": "8.0.2",
     "vitest": "1.4.0",
-    "common": "0.0.0-dev.202408252347"
+    "common": "0.0.0-dev.202408260920"
   },
   "peerDependencies": {
     "@prisma/client": "5.x"