@regardio/react 1.0.2 → 1.1.0

package/README.md

@@ -1,25 +1,25 @@
 # @regardio/react
 
-> Reusable React components from Regardio's projects, released into the wild.
+> Reusable React components from Regardio's projects, shared outward.
 
-Part of Regardio's ongoing mission to provide valuable building blocks for achieving personal and shared aims. We build reusable tools, and commonly used React components from our projects live here for everyone to use.
+Components that have carried real Regardio work, gathered here so other projects don't have to reinvent them. Accessible defaults, Tailwind-aware styling, and a surface shaped by actual use.
 
-## ⚠️ Pre-release Notice
+## Pre-release notice
 
-**This package is currently in pre-release (v0.x).** While we use these components in production across our own projects, the API may still change between minor versions. We recommend:
+This package is currently at v0.x. The components run in production across Regardio's own projects, but the API may still move between minor versions. A few habits that help:
 
-- Pinning to exact versions in your `package.json`
-- Reviewing changelogs before upgrading
-- Expecting potential breaking changes until v1.0
+- Pin to exact versions in `package.json`
+- Read the changelog before upgrading
+- Expect the occasional breaking change until v1.0
 
-## Why This Package?
+## What it's for
 
-We created `@regardio/react` to:
+`@regardio/react` exists so a handful of steady components don't have to be rebuilt in every new app:
 
-- **Share battle-tested components** — These components power real Regardio projects and have been refined through actual use
-- **Reduce duplication** — Instead of copying components between projects, we maintain them in one place
-- **Provide sensible defaults** — Components come pre-configured with accessibility, responsive design, and TailwindCSS integration
-- **Enable tree-shaking** — Import only what you need; unused components won't bloat your bundle
+- **Shared, well-used pieces** — refined through actual product work, not sketched on a whiteboard
+- **One home, not many copies** — components live here instead of drifting apart across projects
+- **Sensible defaults** — accessibility, responsive behaviour, and Tailwind integration come along for the ride
+- **Tree-shakeable** — bring in what's needed, leave the rest out of the bundle
 
 ## Installation
 
@@ -27,9 +27,7 @@ We created `@regardio/react` to:
 pnpm add @regardio/react
 ```
 
-### Peer Dependencies
-
-This package requires:
+### Peer dependencies
 
 - `react` >= 19.0.0
 - `react-dom` >= 19.0.0
@@ -38,7 +36,7 @@ This package requires:
 
 ## Usage
 
-Import components, hooks, and utilities directly from their paths for optimal tree-shaking:
+Import components, hooks, and utilities directly from their paths so tree-shaking does its work:
 
 ```tsx
 import { Box } from '@regardio/react/box';
@@ -46,15 +44,15 @@ import { Link } from '@regardio/react/link';
 import { useNonce } from '@regardio/react/hooks/use-nonce';
 ```
 
-### TailwindCSS Integration
+### TailwindCSS integration
 
-Components use TailwindCSS for styling. Import the base styles in your app:
+Components are styled with Tailwind. Pull the base styles in once, from your app:
 
 ```tsx
 import '@regardio/react/tailwind.css';
 ```
 
-## What's Included
+## What's inside
 
 ### Components
 
@@ -66,12 +64,12 @@ import '@regardio/react/tailwind.css';
 | `Carousel` | Embla-powered carousel with navigation controls |
 | `Countdown` | Dynamic countdown timer display |
 | `GenericError` | React Router error boundary with i18n support |
-| `Heading` | Semantic headings (h1-h6) with consistent styling |
-| `Highlight` | Text highlighting with customizable styles |
-| `IconButton` | Button optimized for icon-only content |
+| `Heading` | Semantic headings (h1–h6) with consistent styling |
+| `Highlight` | Text highlighting with customisable styles |
+| `IconButton` | Button shaped for icon-only content |
 | `If` | Conditional rendering utility component |
 | `Iframe` | Responsive iframe with sensible defaults |
-| `Item` | Grid item with theme colors and link support |
+| `Item` | Grid item with theme colours and link support |
 | `LeafletMap` | Leaflet map integration |
 | `Link` | React Router link with external URL detection |
 | `List` | Compound list component with Root and Item |
@@ -99,16 +97,16 @@ import '@regardio/react/tailwind.css';
 
 | Utility | Description |
 |---------|-------------|
-| `author` | Author/contributor data formatting |
-| `isRouteActive` | Route matching utilities |
+| `author` | Author and contributor data formatting |
+| `isRouteActive` | Route matching helpers |
 | `locale` | Locale detection and formatting |
-| `text` | Typography processing (quotes, special chars) |
+| `text` | Typography processing (quotes, special characters) |
 
-> **Note:** For Tailwind utilities like `cn`, `tv`, and `twMerge`, use `@regardio/tailwind/utils` instead.
+> **Note:** For Tailwind utilities like `cn`, `tv`, and `twMerge`, reach for `@regardio/tailwind/utils`.
 
 ## Documentation
 
-See the [docs](./docs) folder for detailed documentation on each component, hook, and utility.
+The [docs](./docs) folder has detailed notes on each component, hook, and utility.
 
 ## Storybook
 
@@ -120,12 +118,16 @@ pnpm storybook
 
 ## Contributing
 
-This package is primarily maintained for Regardio's internal use, but we welcome:
+The package is maintained primarily for Regardio's own work, but contributions from elsewhere are welcome:
 
 - Bug reports and fixes
 - Documentation improvements
-- Feature suggestions (though we may not implement all requests)
+- Feature suggestions (not every one will become an implementation)
 
 ## License
 
-**MIT License** — Free to use in commercial and open source projects.
+**MIT** — free to use in commercial and open-source projects.
+
+---
+
+*Part of the [Regardio Ensemble](https://regard.io/ensemble) toolkit for shared well-being.*

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://www.schemastore.org/package.json",
   "name": "@regardio/react",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "private": false,
   "description": "Regardio React UI components",
   "keywords": [
@@ -200,8 +200,11 @@
     "embla-carousel": "8.6.0",
     "embla-carousel-react": "8.6.0",
     "markdown-to-jsx": "9.7.16",
-    "@regardio/js": "1.0.2",
-    "@regardio/tailwind": "1.0.2"
+    "react": "19.2.5",
+    "react-dom": "19.2.5",
+    "react-router": "7.14.2",
+    "@regardio/js": "1.1.0",
+    "@regardio/tailwind": "1.1.0"
   },
   "devDependencies": {
     "@storybook/addon-a11y": "10.3.5",
@@ -225,16 +228,11 @@
     "playwright": "1.59.1",
     "storybook": "10.3.5",
     "tailwindcss": "4.2.4",
-    "tsdown": "0.21.9",
+    "tsdown": "0.21.10",
     "typescript": "6.0.3",
-    "vite": "8.0.9",
+    "vite": "8.0.10",
     "vitest": "4.1.5",
-    "@regardio/dev": "2.0.2"
-  },
-  "peerDependencies": {
-    "react": "19.2.5",
-    "react-dom": "19.2.5",
-    "react-router": "7.14.2"
+    "@regardio/dev": "2.1.0"
   },
   "engines": {
     "node": ">=24"