plugins/browser-plugin-focalmeter/README.md
# Snowplow FocalMeter Integration
[![npm version][npm-image]][npm-url]
[![License][license-image]](LICENSE)
Browser Plugin to be used with `@snowplow/browser-tracker`.
Adds integration with the Kantar FocalMeter to your Snowplow tracking.
The plugin sends requests with the domain user ID to a Kantar endpoint used with the FocalMeter system.
A request is made when the first event with a new user ID is tracked.
## Maintainer quick start
Part of the Snowplow JavaScript Tracker monorepo.
Build with [Node.js](https://nodejs.org/en/) (14 or 16) and [Rush](https://rushjs.io/).
### Setup repository
```bash
npm install -g @microsoft/rush
git clone https://github.com/snowplow/snowplow-javascript-tracker.git
rush update
```
## Package Installation
With npm:
```bash
npm install @snowplow/browser-plugin-focalmeter
```
## Usage
Initialize your tracker with the FocalMeterPlugin:
```js
import { newTracker } from '@snowplow/browser-tracker';
import { FocalMeterPlugin } from '@snowplow/browser-plugin-focalmeter';
newTracker('sp1', '{{collector}}', { plugins: [ FocalMeterPlugin() ] }); // Also stores reference at module level
```
## Copyright and license
Licensed and distributed under the [BSD 3-Clause License](LICENSE) ([An OSI Approved License][osi]).
Copyright (c) 2023 Snowplow Analytics Ltd, 2010 Anthon Pang.
All rights reserved.
[npm-url]: https://www.npmjs.com/package/@snowplow/browser-plugin-focalmeter
[npm-image]: https://img.shields.io/npm/v/@snowplow/browser-plugin-focalmeter
[docs]: https://docs.snowplowanalytics.com/docs/collecting-data/collecting-from-own-applications/javascript-tracker/
[osi]: https://opensource.org/licenses/BSD-3-Clause
[license-image]: https://img.shields.io/npm/l/@snowplow/browser-plugin-focalmeter