Skip to content

Commit

Permalink
Update README with browser support info
Browse files Browse the repository at this point in the history
  • Loading branch information
replete committed Aug 7, 2024
1 parent 867fe29 commit 7a79b62
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,18 @@ html.bm-show::after {
}
```

## Browser Support

With browserlist, we're targeting `">= 2%, last 2 years"`. This project is tested with BrowserStack. The earliest versions tested working are:

- Chrome/Edge/Opera: 85+ (released June 2020)
- Firefox: 98+ (released March 2022)
- Safari Desktop+iOS: 15.4+ (released March 2022)
- I couldn't easily test 15.0-15.3, 14.1 is broken though
- Samsung Internet: 14+ (released April 2021)

Currently if this is used in a browser that breaks interactivity (e.g. Safari 14.1, released April 2021), the site is unusable. It might be worth catching errors for unsupported browsers and removing the UI altogether for these extreme edge cases of users not updating their browsers.

## Globals
- `biscuitman` – configuration object, must be `window.biscuitman` (`biscuitman.create(options)` for ESM version)
- `Consent` – object for accessing consents (override: `global` in config)
Expand Down Expand Up @@ -253,8 +265,6 @@ Jest is set up with puppeteer to run some integration tests. We're using `@swc/j

`npm run coverage` - run jest tests with coverage saved to `/coverage/`

This project is tested with BrowserStack.


## Support development

Expand Down

0 comments on commit 7a79b62

Please sign in to comment.