From c5f81e2cb8d2ca45733e2a198d54a8a49ac61b06 Mon Sep 17 00:00:00 2001 From: Kaleb Davenport Date: Tue, 4 Jun 2024 17:28:20 -0400 Subject: [PATCH] Update README.rst --- README.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.rst b/README.rst index 2dcba23..9d5f4d3 100644 --- a/README.rst +++ b/README.rst @@ -122,6 +122,22 @@ You can use the theme in two ways: @import '@edx/elm-theme/paragon/overrides.scss'; +----------------------------------------- +Including Elm Styles in a Paragon Project +----------------------------------------- + +If you're using Paragon with Elm and are migrating from an old theme (default theme or edx-brand), please use this document: + +https://openedx.atlassian.net/wiki/spaces/BPL/pages/3770744958/Migrating+MFEs+to+Paragon+design+tokens+and+CSS+variables#Requirements%3A + +** Follow the above steps before trying to import the elm theme ** + + + +Notes: + 1. This guide is for the alpha branch of Paragon, which is REQUIRED to use Elm until this project is complete https://github.com/openedx/platform-roadmap/issues/360 + 2. run npm install before trying to install elm theme as well. + ------------------------------------- Theming with Paragon's Design Tokens -------------------------------------