@alixpartners/ui-components 2.5.7 → 2.6.1

package/README.md

@@ -1,97 +1,97 @@
-# AlixPartners UI Component Library
-
-A modern, reusable component library built with **[ReactJS](https://react.dev/)**.
-
-Version **2.0** has been **rebuilt from the ground up** to align with the latest **AlixPartners Design System** and deliver improved developer experience, accessibility, and performance.
-
-## ✨ What’s New in 2.0
-
-- Completely redesigned architecture with modern build tooling ([Vite](https://vitejs.dev/))
-- Updated design tokens and styles aligned with AlixPartners Design System
-- Improved accessibility (a11y) and semantic HTML usage
-- Streamlined props API for cleaner integration
-- Enhanced Storybook documentation
-- Faster build & development workflows
-
-### Version Support
-
-- v2.x — Active development (BETA)
-- v1.x — Maintained for legacy projects (no new features, critical fixes only)
-
----
-
-## 🚀 Installation
-
-```bash
-npm install @alixpartners/ui-components
-```
-
-## 🔧 Usage
-
-```tsx
-import { YourComponent } from '@alixpartners/ui-components'
-
-function App() {
-  return <YourComponent />
-}
-```
-
-## 🧱 Components
-
-Explore all available components and documentation in Storybook.
-
-To run it locally:
-
-```bash
-npm run storybook
-```
-
----
-
-## 📦 Build
-
-To bundle the library for publishing:
-
-```bash
-npm run build
-```
-
-The output will be in the `dist/` directory.
-
-### Usage in projects while developing
-
-When working on the library and testing it in another project:
-
-```bash
-# In the component library root:
-npm link
-
-# In the consuming project's root:
-npm link alix-partners-react-components-test
-```
-
-Then import components using the `alix-partners-react-components-test` import.
-
-## 🧪 Testing
-
-```bash
-npm run test
-```
-
-#### 🧪 Test Coverage
-
-```bash
-npm run coverage
-```
-
-## 📚 Publish
-
-To publish to npm:
-
-1. Bump the version in `package.json`
-2. Create a pull request in Azure DevOps to the `main` branch
-3. This will automatically publish the library to `npm` once approved
-
-## 🤝 Contributing
-
-The **AlixPartners UI Component Library** is a collaborative, community-driven project where contributions from all team members are encouraged and valued. If you’d like to add new components or improve existing ones, please see the CONTRIBUTING.md file.
+# AlixPartners UI Component Library
+
+A modern, reusable component library built with **[ReactJS](https://react.dev/)**.
+
+Version **2.0** has been **rebuilt from the ground up** to align with the latest **AlixPartners Design System** and deliver improved developer experience, accessibility, and performance.
+
+## ✨ What’s New in 2.0
+
+- Completely redesigned architecture with modern build tooling ([Vite](https://vitejs.dev/))
+- Updated design tokens and styles aligned with AlixPartners Design System
+- Improved accessibility (a11y) and semantic HTML usage
+- Streamlined props API for cleaner integration
+- Enhanced Storybook documentation
+- Faster build & development workflows
+
+### Version Support
+
+- v2.x — Active development (BETA)
+- v1.x — Maintained for legacy projects (no new features, critical fixes only)
+
+---
+
+## 🚀 Installation
+
+```bash
+npm install @alixpartners/ui-components
+```
+
+## 🔧 Usage
+
+```tsx
+import { YourComponent } from '@alixpartners/ui-components'
+
+function App() {
+  return <YourComponent />
+}
+```
+
+## 🧱 Components
+
+Explore all available components and documentation in Storybook.
+
+To run it locally:
+
+```bash
+npm run storybook
+```
+
+---
+
+## 📦 Build
+
+To bundle the library for publishing:
+
+```bash
+npm run build
+```
+
+The output will be in the `dist/` directory.
+
+### Usage in projects while developing
+
+When working on the library and testing it in another project:
+
+```bash
+# In the component library root:
+npm link
+
+# In the consuming project's root:
+npm link alix-partners-react-components-test
+```
+
+Then import components using the `alix-partners-react-components-test` import.
+
+## 🧪 Testing
+
+```bash
+npm run test
+```
+
+#### 🧪 Test Coverage
+
+```bash
+npm run coverage
+```
+
+## 📚 Publish
+
+To publish to npm:
+
+1. Bump the version in `package.json`
+2. Create a pull request in Azure DevOps to the `main` branch
+3. This will automatically publish the library to `npm` once approved
+
+## 🤝 Contributing
+
+The **AlixPartners UI Component Library** is a collaborative, community-driven project where contributions from all team members are encouraged and valued. If you’d like to add new components or improve existing ones, please see the CONTRIBUTING.md file.