@shortstravelmgmt/component-lib 0.2.11 → 0.2.12-canary.15.geda7028

package/README.md

@@ -111,17 +111,23 @@ The library uses CSS custom properties for theming. Override them in your CSS:
 
 ```css
 :root {
-  /* Primary colors */
-  --color-primary: #0A53EF;
-  --color-primary-dark: #1A43D1;
-  --color-primary-light: #E6ECFB;
-
-  /* Neutral colors */
-  --color-basecolor: #F5F5F5;
-  --border-color: #EDEDED;
-  
-  /* Typography */
-  --font-family-base: 'Roboto Flex', system-ui, sans-serif;
+  /* Primary colors — Short's Blue navy */
+  --color-primary: #19345F;
+  --color-primary-dark: #0C1E3E;
+  --color-primary-light: #E4F1F8;
+
+  /* Accent — Short's Teal (reserved spark) */
+  --color-accent: #00BCD0;
+  --color-accent-ink: #009AAB; /* teal ink for eyebrows/stat figures/focus — clears the 3:1 UI bar on the light page, under the 4.5:1 text bar (brand #00BCD0 in dark) */
+
+  /* Neutral colors — cool, navy-tinted (Short's brand paper, not flat gray) */
+  --color-basecolor: #F4F7FA;
+  --border-color: #E6EDF5;
+
+  /* Typography — Inter (body/UI) · Montserrat (display) · Roboto Condensed (chrome) */
+  --font-family-base: 'Inter', system-ui, sans-serif;
+  --font-family-display: 'Montserrat', system-ui, sans-serif;
+  --font-family-label: 'Roboto Condensed', system-ui, sans-serif;
 }
 ```
 
@@ -174,10 +180,51 @@ npm run build:lib
 npm publish --access public
 ```
 
+## 🐤 Canary releases
+
+Every pull request that targets `staging` publishes a canary build to npm, so
+Hub and Portal can install a branch before it merges. No release, tag, or
+version commit is needed.
+
+Canary versions are ordinary `major.minor.patch` versions with a prerelease
+suffix naming the pull request and commit they came from:
+
+```
+0.2.10-canary.42.g1a2b3c4
+└─────┘ └────┘ └┘ └─────┘
+release canary PR  commit
+```
+
+Install one with the exact version — the canary bot comments the command on
+the pull request:
+
+```bash
+npm install @shortstravelmgmt/component-lib@0.2.10-canary.42.g1a2b3c4
+```
+
+Canaries are published under the `canary` dist-tag and, being prereleases,
+never satisfy a plain `^0.2.9` range. Nothing that installs normally can pick
+one up by accident.
+
+### Choosing the bump level
+
+Label the pull request to say what the eventual `staging` release should be:
+
+| Label | Base `0.2.9` becomes | Use for |
+| --- | --- | --- |
+| `bump:major` | `1.0.0` | Breaking API or prop changes |
+| `bump:minor` | `0.3.0` | New components or props |
+| `bump:patch` *(default)* | `0.2.10` | Fixes and styling changes |
+
+Relabelling republishes the canary at the new version. The Storybook sidebar
+shows the version it was built from, so a canary Storybook names the exact
+package to install.
+
 ## 🔄 CI/CD
 
 - **CI Pipeline** - Runs on every push/PR: lint, typecheck, build
 - **Chromatic** - Visual regression testing on every PR
+- **Canary** - Prerelease npm publish on every PR into `staging`
 - **Publish** - Automatic npm publishing on releases
 
 ## 🤝 Contributing