@tracewayapp/vue 0.2.0 → 1.0.0

package/README.md

@@ -1,54 +1,69 @@
 # @tracewayapp/vue
 
-Vue.js integration for Traceway. Provides a plugin with automatic error handling and a composable hook.
+Vue 3 integration for Traceway. Provides a plugin with automatic error handling and a composable.
+
+## Installation
+
+```bash
+npm install @tracewayapp/vue
+```
 
 ## Setup
 
-```ts
+Install the Traceway plugin in your Vue application:
+
+```typescript
 import { createApp } from "vue";
 import { createTracewayPlugin } from "@tracewayapp/vue";
 import App from "./App.vue";
 
 const app = createApp(App);
 
-app.use(
-  createTracewayPlugin({
-    connectionString: "your-token@https://your-server.com/api/report",
-    options: { debug: true }, // optional
-  })
-);
+app.use(createTracewayPlugin({
+  connectionString: "your-token@https://traceway.example.com/api/report",
+}));
 
 app.mount("#app");
 ```
 
-## Automatic Error Handling
-
-The plugin automatically installs a global error handler (`app.config.errorHandler`) that captures all Vue component errors and reports them to Traceway.
+The plugin automatically installs a global error handler that captures uncaught errors.
 
 ## useTraceway Composable
 
-Access capture methods from any component.
+Use the `useTraceway` composable to capture errors in components:
 
 ```vue
-<script setup lang="ts">
+<script setup>
 import { useTraceway } from "@tracewayapp/vue";
 
-const { captureException, captureMessage } = useTraceway();
+const { captureException } = useTraceway();
 
-function handleClick() {
+async function handleSubmit() {
   try {
-    doSomething();
-  } catch (err) {
-    captureException(err as Error);
+    await submitForm();
+  } catch (error) {
+    captureException(error);
   }
 }
 </script>
 
 <template>
-  <button @click="handleClick">Do Something</button>
+  <button @click="handleSubmit">Submit</button>
 </template>
 ```
 
+## With Options
+
+```typescript
+app.use(createTracewayPlugin({
+  connectionString: "your-token@https://traceway.example.com/api/report",
+  options: {
+    debug: true,
+    version: "1.0.0",
+  },
+}));
+```
+
 ## API
 
 ### createTracewayPlugin(options)

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@tracewayapp/vue",
-  "version": "0.2.0",
+  "version": "1.0.0",
   "description": "Traceway Vue.js integration with plugin and composable",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
     }
   },
   "files": [
@@ -23,7 +23,7 @@
     "dev": "tsup --watch"
   },
   "dependencies": {
-    "@tracewayapp/frontend": "0.2.0"
+    "@tracewayapp/frontend": "1.0.0"
   },
   "peerDependencies": {
     "vue": ">=3.3.0"