docs: add notes on platform support (#838)

uuidjs · Nov 20, 2024 · 59df709 · 59df709
1 parent 1370497
commit 59df709
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -8,10 +8,10 @@
 For the creation of [RFC9562](https://www.rfc-editor.org/rfc/rfc9562.html) (formally [RFC4122](https://www.rfc-editor.org/rfc/rfc4122.html)) UUIDs
 
 - **Complete** - Support for all RFC9562 UUID versions
-- **Cross-platform** - Support for ...
-  - CommonJS, [ECMAScript Modules](#ecmascript-modules)
-  - NodeJS 16+ ([LTS releases](https://github.com/nodejs/Release))
-  - Chrome, Safari, Firefox, Edge browsers
+- **Cross-platform** - Support for...
+  - ESM & Common JS
+  - [Chrome, Safari, Firefox, Edge browsers](#support)
+  - [NodeJS](#support)
   - [React Native / Expo](#react-native--expo)
 - **Secure** - Cryptographically-strong random values
 - **Compact** - No dependencies, [tree-shakable](https://developer.mozilla.org/en-US/docs/Glossary/Tree_shaking)
@@ -480,6 +480,14 @@ Prior to `uuid@11`, it was possible for `options` state to interfere with the in
 - Without `options`: Internal state is utilized to improve UUID uniqueness.
 - With `options`: Internal state is **NOT** used and, instead, appropriate defaults are applied as needed.
 
+## Support
+
+**Browsers**: `uuid` [builds are tested](/uuidjs/uuid/blob/main/wdio.conf.js) against the latest version of desktop Chrome, Safari, Firefox, and Edge. Mobile versions of these same browsers are expected to work but aren't currently tested.
+
+**Node**: `uuid` [builds are tested](https://github.com/uuidjs/uuid/blob/main/.github/workflows/ci.yml#L26-L27) against node ([LTS releases](https://github.com/nodejs/Release)), plus one prior. E.g. `node@18` is in maintainence mode, and `node@22` is the current LTS release. So `uuid` supports `node@16`-`node@22`.
+
+**Typescript**: TS versions released within the past two years are supported. [source](https://github.com/microsoft/TypeScript/issues/49088#issuecomment-2468723715)
+
 ## Known issues
 
 ### React Native / Expo

diff --git a/README_js.md b/README_js.md
@@ -22,10 +22,10 @@ require('crypto').randomUUID = undefined;
 For the creation of [RFC9562](https://www.rfc-editor.org/rfc/rfc9562.html) (formally [RFC4122](https://www.rfc-editor.org/rfc/rfc4122.html)) UUIDs
 
 - **Complete** - Support for all RFC9562 UUID versions
-- **Cross-platform** - Support for ...
-  - CommonJS, [ECMAScript Modules](#ecmascript-modules)
-  - NodeJS 16+ ([LTS releases](https://github.com/nodejs/Release))
-  - Chrome, Safari, Firefox, Edge browsers
+- **Cross-platform** - Support for...
+  - ESM & Common JS
+  - [Chrome, Safari, Firefox, Edge browsers](#support)
+  - [NodeJS](#support)
   - [React Native / Expo](#react-native--expo)
 - **Secure** - Cryptographically-strong random values
 - **Compact** - No dependencies, [tree-shakable](https://developer.mozilla.org/en-US/docs/Glossary/Tree_shaking)
@@ -488,6 +488,14 @@ Prior to `uuid@11`, it was possible for `options` state to interfere with the in
 - Without `options`: Internal state is utilized to improve UUID uniqueness.
 - With `options`: Internal state is **NOT** used and, instead, appropriate defaults are applied as needed.
 
+## Support
+
+**Browsers**: `uuid` [builds are tested](/uuidjs/uuid/blob/main/wdio.conf.js) against the latest version of desktop Chrome, Safari, Firefox, and Edge. Mobile versions of these same browsers are expected to work but aren't currently tested.
+
+**Node**: `uuid` [builds are tested](https://github.com/uuidjs/uuid/blob/main/.github/workflows/ci.yml#L26-L27) against node ([LTS releases](https://github.com/nodejs/Release)), plus one prior. E.g. `node@18` is in maintainence mode, and `node@22` is the current LTS release. So `uuid` supports `node@16`-`node@22`.
+
+**Typescript**: TS versions released within the past two years are supported. [source](https://github.com/microsoft/TypeScript/issues/49088#issuecomment-2468723715)
+
 ## Known issues
 
 ### React Native / Expo