@ucalgary-design-system/core 1.0.6 → 1.0.7

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ucalgary-design-system/core
 
+## 1.0.7
+
+### Patch Changes
+
+- 148b308: Added base styles to Core package.
+
 ## 1.0.6
 
 ### Patch Changes

package/README.md

@@ -1,33 +1,55 @@
 # Core
 
-This package provides general assets and styles for UCDS web components. It also includes the **BaseElement** web component that all UCDS web components extend.
+The Core package provides the foundation for all UCDS web components.
+It includes:
 
-## Installation
+* **BaseElement** — the base class extended by all UCDS components.
+* **Base styles** — global UCalgary Design System styles for standard HTML elements.
+* **Token injector** — a utility that ensures design tokens are available wherever UCDS components are used.
 
-Install the component using npm:
+## Installation
 
 ```sh
-npm install @ucalgary-design-system/button
+npm install @ucalgary-design-system/core
 ```
 
 ## Usage
 
-Import the component into your application:
+### Extending BaseElement
+
+When creating a new component, always extend `BaseElement`:
 
 ```ts
-import '@ucalgary-design-system/core';
+import { BaseElement } from '@ucalgary-design-system/core';
+import { customElement } from 'lit/decorators.js';
+
+@customElement('ucds-my-component')
+export class MyComponent extends BaseElement {}
 ```
 
-When creating a new component, ensure that it extends the BaseElement.
-For example: 
+This ensures consistent lifecycle behavior and integration with UCDS utilities.
+
+### Token injector
+
+All generated UCDS components automatically include the token injector in their entry file.
+This means **you do not need to call it manually** when consuming components from the library.
+
+You might only need to call it directly if:
+
+* You are building a custom component outside of the generator.
+* You want global tokens available in a project without using UCDS components.
+
 ```ts
-@customElement('ucds-my-component')
-export class MyComponent extends BaseElement { }
+import { injectGlobalTokens } from '@ucalgary-design-system/core';
+
+injectGlobalTokens();
 ```
 
+> 💡 In most cases, you can ignore this. The injector runs automatically when you use UCDS components.
+
 ## Development
 
-Build the component:
+Build the package locally:
 
 ```sh
 npm run build