diff --git a/packages/connect-web/README.md b/packages/connect-web/README.md index b466017c9a4..f8a7e674524 100644 --- a/packages/connect-web/README.md +++ b/packages/connect-web/README.md @@ -54,3 +54,18 @@ For more instructions [refer to this document](https://github.com/trezor/trezor- - install node_modules: `yarn && yarn build:libs` - generate certs `yarn workspace @trezor/connect-web predev` - It is possible to run local dev server with iframe and popup using: `yarn workspace @trezor/connect-web dev` Note: don't forget to visit `https://localhost:8088/` and allow self-signed certificate. No UI is displayed here. + +## TrezorConnect Support Matrix + +The table below details the support for different environments by TrezorConnect for integrating Trezor devices, including the use of WebUSB and the need for Trezor Bridge. + +| Environment | Chrome | Firefox | Safari | Chrome Android | Firefox Android | Notes | +| ----------------------------- | :----: | :-----: | :----: | :------------: | :-------------: | ----------------------------------------------------------------------- | +| Web (WebUSB) | ✓ | ✗ | ✗ | ✓ | ✗ | WebUSB is fully supported where indicated. (Chromium based browsers) | +| Web (Bridge) | ✓ | ✓ | ✗ | ✗ | ✗ | Trezor Bridge is required where WebUSB is not supported. (e.g. Firefox) | +| WebExtension (WebUSB, Bridge) | ✓ | ✓ | ✗ | ✓ | ✗ | Requires Trezor Bridge on platforms not supporting WebUSB. | + +## Key Differences + +- **WebUSB**: Allows direct communication with Trezor devices via the browser. Supported by most modern browsers but may have limitations on mobile devices and is not supported by Safari. +- **Trezor Bridge**: A service that runs with Trezor Suite or Standalone that facilitates communication between your Trezor device and a web browser. Required for browsers that do not support WebUSB or for a more stable connection on desktop environments. diff --git a/packages/connect-web/src/webextension/README.md b/packages/connect-web/src/webextension/README.md index 77dedb276f0..5c5a5b494ab 100644 --- a/packages/connect-web/src/webextension/README.md +++ b/packages/connect-web/src/webextension/README.md @@ -1,6 +1,6 @@ # Integrate @trezor/connect with a web extension -**Note: only manifest version 2 is supported for now** +**Note: Only manifest version 2 web extensions are supported by this package. For manifest version 3, use the [@trezor/connect-webextension](https://github.com/trezor/trezor-suite/tree/develop/packages/connect-webextension) package** [Example of a web extension project for both Google Chrome & Firefox](../../../connect-examples/webextension/README.md) diff --git a/packages/connect-webextension/README.md b/packages/connect-webextension/README.md index efb62810701..fff1e52e097 100644 --- a/packages/connect-webextension/README.md +++ b/packages/connect-webextension/README.md @@ -4,7 +4,7 @@ [![NPM](https://img.shields.io/npm/v/@trezor/connect-webextension.svg)](https://www.npmjs.org/package/@trezor/connect-webextension) [![Known Vulnerabilities](https://snyk.io/test/github/trezor/connect-webextension/badge.svg?targetFile=package.json)](https://snyk.io/test/github/trezor/trezor-suite?targetFile=packages/connect-webextension/package.json) -The @trezor/connect-webextension package provides an implementation of @trezor/connect designed specifically for use within web extensions. Key features include: +The `@trezor/connect-webextension` package provides an implementation of `@trezor/connect` designed specifically for use within web extensions. Key features include: - Compatibility with service worker environments. - Full access to the TrezorConnect API.