diff --git a/README.md b/README.md index f9672c2..9703a18 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ Pass these options to the HoneycombWebSDK: #### `WebVitalsInstrumentationConfig` | name | required? | type | default value | description | | ---- | --------- | ---- | ------------- | ----------- | -| enabled | optional | boolean | `true` | Where or not to enable this auto instrumentation. | +| enabled | optional | boolean | `true` | Whether or not to enable this auto instrumentation. | | lcp| optional| VitalOpts | `undefined` | Pass-through config options for web-vitals. See [ReportOpts](https://github.com/GoogleChrome/web-vitals?tab=readme-ov-file#reportopts). | lcp.applyCustomAttributes| optional| function | `undefined` | A function for adding custom attributes to core web vitals spans. | lcp.dataAttributes| optional| `string[]` | `undefined` | An array of attribute names to filter reported as `lcp.element.data.someAttr`
  • `undefined` will send all `data-*` attribute-value pairs.
  • `[]` will send none
  • `['myAttr']` will send the value of `data-my-attr` or `''` if it's not supplied.

    Note: An attribute that's defined, but that has no specified value such as `

    ` will be sent as `{`lcp.element.data.myAttr`: '' }` which is inline with the [dataset API]( https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/dataset).