@maggioli-design-system/design-tokens 13.7.1 → 14.0.0

package/README.md

@@ -4,6 +4,15 @@ Generates design tokens for colors and other type of agnostic tokens targeted on
 
 This library is based on [Adobe Leonardo][adobe-leonardo] and [Amazon Style Dictionary][style-dictionary].
 
+# Compatibility
+
+Use the version of this package matching the major version of [`@maggioli-design-system/magma`](https://www.npmjs.com/package/@maggioli-design-system/magma) you are using:
+
+| magma | design-tokens | styles |
+| :--- | :--- | :--- |
+| `1.x` (before Magma 2) | `13.x` (latest `13.7.2`) | `15.x` (latest `15.11.1`) |
+| `2.x` and later | `>= 14` | `>= 16` |
+
 # Installation
 
 Install the component via `npm` by running the following command:
@@ -68,7 +77,7 @@ Basic config
 ```json
 {
   "colors": [
-    { "color": "#94a3b8", "name": "tone.slate" },
+    { "color": "#94a3b8", "name": "tone.porcelain" },
     { "color": "#EA3464", "name": "label.amaranth" }
   ]
 }
@@ -79,7 +88,7 @@ You can export different color in different output file defining export field
 ```json
 {
   "colors": [
-    { "color": "#94a3b8", "name": "tone.slate", "export": ["tones"] },
+    { "color": "#94a3b8", "name": "tone.porcelain", "export": ["tones"] },
     { "color": "#EA3464", "name": "label.amaranth", "export": ["label"] }
   ]
 }
@@ -90,7 +99,7 @@ You can choose the ratio with which to generate the color scale with `ratios` fi
 ```json
 {
   "colors": [
-    { "color": "#94a3b8", "name": "tone.slate", "ratios": "tone" },
+    { "color": "#94a3b8", "name": "tone.porcelain", "ratios": "tone" },
     { "color": "#EA3464", "name": "label.amaranth", "ratios": "v1" }
   ]
 }