From a7ba471a627b03b0849682b1301bc4c5474baba7 Mon Sep 17 00:00:00 2001 From: Elizabeth Mitchell Date: Mon, 24 Nov 2025 14:53:14 -0800 Subject: [PATCH] fix(tokens): add readme for the `@material/web/tokens/versions` folder PiperOrigin-RevId: 836373118 --- tokens/versions/README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 tokens/versions/README.md diff --git a/tokens/versions/README.md b/tokens/versions/README.md new file mode 100644 index 0000000000..6777813f5f --- /dev/null +++ b/tokens/versions/README.md @@ -0,0 +1,26 @@ +This folder contains auto-generated files for Material Design token versions. + +> **WARNING: These files may unexpectedly change across different non-major +> versions of `@material/web`.** +> +> Most users should ignore this folder and use other APIs provided by +> `@material/web/tokens`. + +`@material/web/tokens/versions` is useful for custom implementations of or +experimentations with the Material Design system. + +To avoid unexpected breakages when using these files, save the *exact version* +of `@material/web` instead of a version range (e.g. `@2.0.0` instead of +`@^2.0.0`). + +``` +Example of a minor breaking change: + + +@material/web@2.0.0/tokens/version/v5_0/_md-sys-color.scss + +The path to this file may break in a typically non-breaking minor version bump. + + +@material/web@2.1.0/tokens/version/v5_1/_md-sys-color.scss +```