@picked/fingerprintjs 0.0.101-next.2 → 0.0.101-next.3

package/README.md

@@ -1,37 +1,34 @@
-# FingerprintJS
+# @picked/fingerprintjs
 
-## 🚀 Quick Start
+Adds the FingerprintJS visitor ID to the Picked session, so analytics events carry it.
 
-`@picked/fingerprintjs` is a plugin that automatically adds the FingerprintJS visitor ID to the analytics session, if it exists.
+## Install
 
-When added to the `createClient` `plugins` array, it will attempt to read `window.FingerprintJS` and store the resolved visitor ID in the session store under an internal key. The plugin automatically polls for `window.FingerprintJS` for up to 10 seconds and saves the `visitorId` when available. See below for how to import and use it.
+```bash
+npm install picked @picked/fingerprintjs
+```
+
+Load FingerprintJS on the page yourself; this package does not include it.
 
-## Snowplow integration
+## Usage
 
-After the plugin is initialized via `createClient` (i.e. the plugin is included in the `plugins` array and the client is started), the FingerprintJS visitor ID will be automatically added to the Snowplow session event as the `fingerprintjs_visitor_id` field.
+```typescript
+import { createClient } from 'picked'
+import { fingerprintjsPlugin } from '@picked/fingerprintjs'
 
-## Using the `fingerprintjsPlugin`
+export const picked = createClient({
+  projectId: 'your-project-id',
+  plugins: [fingerprintjsPlugin()],
+})
+```
 
-You should import the `fingerprintjsPlugin` from the package `@picked/fingerprintjs` and add it to the `plugins` array passed to `createClient`.
+The plugin waits up to 10 seconds for `window.FingerprintJS`, then stores its `visitorId` as
+the `fingerprintjs_visitor_id` session identifier. Analytics events send it in their
+`session` context. It does nothing outside a browser.
 
-Example usage:
+## Docs
 
-```typescript
-import { createClient, fingerprintjsPlugin } from '@picked/fingerprintjs'
-
-function app() {
-  try {
-    const plugins: CreateClientOptions['plugins'] = [fingerprintjsPlugin()]
-
-    const client = createClient({
-      projectId: 'project-id',
-      predicates: {},
-      plugins,
-    })
-
-    client.start()
-  } catch (error) {
-    throw error
-  }
-}
-```
+- **Web:** [FingerprintJS](https://docs.picked.app/reference/sdk/plugins/fingerprintjs)
+- **Local:** `node_modules/picked/docs/reference/sdk/plugins/fingerprintjs.md`. The `picked` package carries every page under `node_modules/picked/docs/`.
+- **CLI:** `npx picked docs read /reference/sdk/plugins/fingerprintjs`. `npx picked docs list [words]` lists the pages.
+- **MCP:** call `read_picked_doc` with `{ "path": "/reference/sdk/plugins/fingerprintjs" }`; `list_picked_docs` lists the pages. Add the server with `claude mcp add --transport http picked https://api.picked.app/mcp`, or see [How to connect the MCP server](https://docs.picked.app/how-to/connect-the-mcp-server) for other tools.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@picked/fingerprintjs",
   "description": "Fingerprintjs plugin",
-  "version": "0.0.101-next.2",
+  "version": "0.0.101-next.3",
   "devDependencies": {
     "@picked/client": "workspace:*",
     "@repo/eslint-config": "workspace:*",
@@ -45,7 +45,7 @@
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
   "peerDependencies": {
-    "@picked/client": "0.0.101-next.2"
+    "@picked/client": "0.0.101-next.3"
   },
   "private": false,
   "publishConfig": {