@webority/theme 0.3.0 → 0.4.0

package/README.md

@@ -1,40 +1,29 @@
 # @webority/theme
 
-The single source of Webority brand chrome — Bootstrap 5.3 SCSS overrides, `--wui-*` design tokens, and shared component CSS. Consumed identically by React portals (`@webority/ui-react`) and Razor sites (`Webority.Ui.Razor`).
+Webority's internal design system — Bootstrap 5.3 SCSS overrides, `--wui-*` tokens, and
+shared component CSS. Consumed by `@webority/ui-react` and `Webority.Ui.Razor`.
 
-## Consume (brand-exact — the primary path)
+Published publicly so `npm install` needs no private registry. Built for Webority
+products; no support commitment outside them.
 
-Compile the partials with your product's brand values, in the load-bearing order:
+## Use
+
+Compile the partials with your brand values, in this order — **the order is
+load-bearing**:
 
 ```scss
-// your-brand/_variables.scss provides $primary, fonts, etc. BEFORE bootstrap.
-@import "your-brand/variables";
-@import "@webority/theme/scss/variables";      // library defaults (yours win where set)
+@import "your-brand/variables";                // your $primary, fonts, etc.
+@import "@webority/theme/scss/variables";      // library defaults (yours win)
 @import "bootstrap/scss/bootstrap";
 @import "@webority/theme/scss/tokens";         // --wui-* tokens
-@import "@webority/theme/scss/wui-aliases";    // --color-*/--radius-*/--shadow-* aliases
-@import "@webority/theme/scss/components";     // shared components
-@import "@webority/theme/scss/wui-components"; // portal component layer
-@import "@webority/theme/scss/flags";          // country flags (needed by AppPhoneNumberInput)
-// map your product's legacy --<brand>-* names onto --wui-* here (alias layer)
+@import "@webority/theme/scss/wui-aliases";    // --color-* / --radius-* aliases
+@import "@webority/theme/scss/components";
+@import "@webority/theme/scss/wui-components";
+@import "@webority/theme/scss/flags";          // country flags (phone input)
 ```
 
-The order is load-bearing. Importing only part of the chain is a bug — e.g. skipping
-`wui-aliases` leaves every `--color-*` reference in the component layer unresolved, and
-skipping `flags` leaves the phone input's country flags blank.
-
-Both Razor (`sass`/`CompileScss`) and React (Vite) already compile SCSS, so this path gives full Bootstrap utility-class fidelity.
-
-## Consume (zero-toolchain — the convenience path)
-
-`dist/webority-theme.css` is the precompiled default-brand build (also shipped inside the `Webority.Ui.Razor` RCL as a static asset). Good for ~80% of theming via runtime `--wui-*` / `--bs-*` overrides; not pixel-exact on every Bootstrap utility. Prefer the brand-exact path for marketing surfaces.
-
-## Files
-
-| Partial | Loaded | Holds |
-|---|---|---|
-| `scss/_variables.scss` | BEFORE bootstrap | Bootstrap `$` overrides (brand palette, fonts, radius, spacing) |
-| `scss/_tokens.scss` | AFTER bootstrap | `--wui-*` CSS custom properties (ramps, surfaces, gradients, easings) |
-| `scss/_components.scss` | AFTER bootstrap + tokens | Shared component CSS that must render identically on both surfaces |
+Importing part of the chain is a bug: skipping `wui-aliases` leaves every `--color-*`
+reference unresolved, and skipping `flags` leaves the phone input's flags blank.
 
-> Tokens are neutralized to `--wui-*` with a neutral indigo default palette. Each consuming product supplies its own brand `$`-variables before this theme and (optionally) maps legacy token names onto `--wui-*` via a small alias layer — brand values are never re-declared here.
+`dist/webority-theme.css` is a precompiled default-brand build for when there is no SCSS
+toolchain. It is not pixel-exact on every Bootstrap utility — prefer the chain above.