From 36451b65e4dc3e081f46b64a54b69c4ef4ad173e Mon Sep 17 00:00:00 2001 From: Dale Sande Date: Mon, 25 Sep 2023 19:59:05 -0700 Subject: [PATCH] docs: add content to support migration to new version Changes to be committed: modified: README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 5b3f29d..a63fe9b 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,12 @@ This repository is a library of core level styles, functions, and mixins that ca Please see the [documentation site](https://alaskaairlines.github.io/WebCoreStyleSheets/) for all information related to WC Style Sheets. +## Design tokens and legacy component support + +Upgrading to WCSS `v5.x` requires `@aurodesignsystem/design-tokens@4.x`. + +When upgrading your project it is required to also retain `@alaskaairux/design-tokens@v3.15.5` in order to support Auro custom elements have been updated to support the [new design token naming convention](https://github.com/AlaskaAirlines/AuroDesignTokens/issues/118). + ## Install [![Build Status](https://img.shields.io/github/actions/workflow/status/AlaskaAirlines/webcorestylesheets/testPublish.yml?style=for-the-badge)](https://github.com/AlaskaAirlines/webcorestylesheets/actions/workflows/testPublish.yml)