@honeyicons/react 0.0.1 → 0.0.2

package/MIGRATION.md

@@ -10,47 +10,47 @@ All other renamed exports remain available as deprecated aliases. The catalog li
 
 ## Renamed exports
 
-| Previous export | Canonical export |
-| --- | --- |
-| `ArrowDown` | `ChevronDown` |
-| `ArrowDown02` | `ArrowDown` |
-| `ArrowDownDouble` | `ChevronsDown` |
-| `ArrowLeft` | `ChevronLeft` |
-| `ArrowLeft02` | `ArrowLeft` |
-| `ArrowLeftDouble` | `ChevronsLeft` |
-| `ArrowRight` | `ChevronRight` |
-| `ArrowRight02` | `ArrowRight` |
-| `ArrowRightDouble` | `ChevronsRight` |
-| `ArrowUp` | `ChevronUp` |
-| `ArrowUp02` | `ArrowUp` |
-| `ArrowUpDouble` | `ChevronsUp` |
-| `Branch` | `GitBranch` |
-| `Calendar03` | `Calendar` |
-| `CheckCheck` | `CheckDouble` |
-| `Danger` | `AlertTriangle` |
-| `Edit01` | `Edit` |
-| `Exit` | `DoorOpen` |
-| `FileRead` | `FileCheck` |
-| `Folder01` | `Folder` |
-| `Hamburger` | `Menu` |
-| `Headphone` | `Headphones` |
-| `Images` | `Image` |
-| `ImagesAdd` | `ImageAdd` |
-| `Insta` | `Instagram` |
-| `LockUnlock` | `LockOpen` |
-| `MergeConflict` | `GitMergeConflict` |
-| `MsCopilot` | `MicrosoftCopilot` |
-| `Muted` | `VolumeOff` |
-| `Pallet` | `Archive` |
-| `SearchMinus` | `ZoomOut` |
-| `SearchPlus` | `ZoomIn` |
-| `SendMessage` | `SquarePen` |
-| `SpinnerLarge` | `SpinnerArc` |
-| `SpinnerTinker` | `SpinnerWave` |
-| `Tool` | `Hammer` |
-| `Ts` | `Typescript` |
-| `Videocamera` | `VideoCamera` |
-| `Volume` | `VolumeLow` |
-| `VolumeLoud` | `VolumeHigh` |
+| Previous export    | Canonical export   |
+| ------------------ | ------------------ |
+| `ArrowDown`        | `ChevronDown`      |
+| `ArrowDown02`      | `ArrowDown`        |
+| `ArrowDownDouble`  | `ChevronsDown`     |
+| `ArrowLeft`        | `ChevronLeft`      |
+| `ArrowLeft02`      | `ArrowLeft`        |
+| `ArrowLeftDouble`  | `ChevronsLeft`     |
+| `ArrowRight`       | `ChevronRight`     |
+| `ArrowRight02`     | `ArrowRight`       |
+| `ArrowRightDouble` | `ChevronsRight`    |
+| `ArrowUp`          | `ChevronUp`        |
+| `ArrowUp02`        | `ArrowUp`          |
+| `ArrowUpDouble`    | `ChevronsUp`       |
+| `Branch`           | `GitBranch`        |
+| `Calendar03`       | `Calendar`         |
+| `CheckCheck`       | `CheckDouble`      |
+| `Danger`           | `AlertTriangle`    |
+| `Edit01`           | `Edit`             |
+| `Exit`             | `DoorOpen`         |
+| `FileRead`         | `FileCheck`        |
+| `Folder01`         | `Folder`           |
+| `Hamburger`        | `Menu`             |
+| `Headphone`        | `Headphones`       |
+| `Images`           | `Image`            |
+| `ImagesAdd`        | `ImageAdd`         |
+| `Insta`            | `Instagram`        |
+| `LockUnlock`       | `LockOpen`         |
+| `MergeConflict`    | `GitMergeConflict` |
+| `MsCopilot`        | `MicrosoftCopilot` |
+| `Muted`            | `VolumeOff`        |
+| `Pallet`           | `Archive`          |
+| `SearchMinus`      | `ZoomOut`          |
+| `SearchPlus`       | `ZoomIn`           |
+| `SendMessage`      | `SquarePen`        |
+| `SpinnerLarge`     | `SpinnerArc`       |
+| `SpinnerTinker`    | `SpinnerWave`      |
+| `Tool`             | `Hammer`           |
+| `Ts`               | `Typescript`       |
+| `Videocamera`      | `VideoCamera`      |
+| `Volume`           | `VolumeLow`        |
+| `VolumeLoud`       | `VolumeHigh`       |
 
 SVG filenames follow the same mapping in kebab-case, for example `send-message.svg` becomes `square-pen.svg`.

package/README.md

@@ -21,14 +21,45 @@ export function Toolbar() {
 
 Requires React 18 or later. Icons accept SVG props, `size` (default `24`),
 `color` (default `currentColor`), and `strokeWidth` (default `1.5`).
-Use `title` to give an icon an accessible name. Icons without a title are
-decorative by default.
+Use `title`, `aria-label`, or `aria-labelledby` to give an icon an accessible
+name. Icons without a name are decorative by default. Explicit `role` and
+`aria-hidden` props override these defaults.
+
+For an icon-only button, put the accessible name on the button:
+
+```tsx
+import { Bell } from "@honeyicons/react";
+
+export function NotificationsButton() {
+	return (
+		<button type="button" aria-label="Notifications">
+			<Bell size={20} />
+		</button>
+	);
+}
+```
+
+Use `className` and `style` for styling, and `size` for both dimensions (numbers
+or CSS lengths such as `"1em"`). Icons inherit the surrounding text color and
+forward `ref` to the SVG element. Standard SVG props, event handlers, and
+children such as `<desc>` are supported.
 
 Linear is the default variant. Selected icons also support other variants;
 check the component's `variants` property before choosing one. Stroke width
 affects stroked geometry; filled outlines retain their original geometry.
+Unsupported variants fall back to linear.
+
+Catalog data is available as the named `catalog` export from
+`@honeyicons/react/catalog`. For reusable components, import the `HoneyIcon`
+and `HoneyIconProps` types from `@honeyicons/react`.
+
+The published package contains ESM JavaScript and TypeScript declarations.
+Named icon imports support tree shaking; importing the catalog includes the
+full collection.
 
-Catalog data is available from `@honeyicons/react/catalog`.
+To build or package from this repository, run `bun run build` or `bun pm pack`
+inside `packages/react`. Packing builds the package automatically. The web app
+and shared UI resolve the source through TypeScript paths during development.
 
 See [NOTICE.md](./NOTICE.md) for third-party icon licenses and attribution,
 and [MIGRATION.md](./MIGRATION.md) for renamed exports.