foamicons 0.10.1 → 1.0.0

package/llms.txt

@@ -0,0 +1,66 @@
+# Foamicons
+
+React SVG icon library with 170+ icons and 14 brand logos in three styles.
+
+## Naming
+
+- All component names are PascalCase.
+- Base (stroked) icons have no suffix: `Bell`
+- Duotone variant: `BellDuotone`
+- Filled variant: `BellFill`
+- Logos use `Logo` prefix: `LogoInstagram`
+  - Dark variant: `LogoInstagramDark`
+  - Fill variant (currentColor): `LogoInstagramFill`
+
+## Aliases
+
+Many icons have semantic aliases (e.g. `Settings` -> `Cog`, `Home` -> `House`).
+Aliases are valid imports but canonical names are preferred in generated code.
+Aliases apply to all variants: `Settings`, `SettingsDuotone`, `SettingsFill`.
+
+## Metadata (machine-readable)
+
+Read the catalog instead of parsing dist/index.js:
+
+```js
+import catalog from 'foamicons/catalog';   // { version, icons, logos, deprecated }
+import aliases from 'foamicons/aliases';     // { alias: canonical }
+import tags from 'foamicons/tags';           // { canonical: [tags] }
+import deprecations from 'foamicons/deprecations'; // { old: new }
+```
+
+Each catalog entry has: name, kind, variants, aliases, tags.
+
+## Typed helpers (runtime)
+
+```ts
+import {
+  iconNames,        // readonly string[] of all icon component names
+  logoNames,        // readonly string[] of all logo component names
+  allNames,         // combined
+  baseIconNames,    // base names without variant suffixes
+  baseLogoNames,    // base logo names without variant suffixes
+  iconAliases,      // { canonical: [aliases] }
+  aliasToCanonical, // { alias: canonical }
+  iconTags,         // { canonical: [tags] }
+  getCanonicalName, // (nameOrAlias) => canonical
+} from 'foamicons';
+
+// TypeScript types
+import type { IconName, LogoName, BaseIconName, BaseLogoName } from 'foamicons';
+```
+
+## Usage
+
+```tsx
+import { Bell, BellDuotone, BellFill } from 'foamicons';
+
+<Bell className="h-4 w-4" />
+<BellDuotone secondaryOpacity={0.4} />
+<BellFill size={24} />
+```
+
+## Props
+
+size (default 16), strokeWidth (default 1), absoluteStrokeWidth (default true),
+color, secondaryColor, secondaryOpacity (default 0.4), className, ...SVGProps.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "foamicons",
-  "version": "0.10.1",
+  "version": "1.0.0",
   "description": "Foam icon library for React",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -16,15 +16,28 @@
         "types": "./dist/index.d.cts",
         "default": "./dist/index.cjs"
       }
+    },
+    "./catalog": {
+      "default": "./dist/catalog.json"
+    },
+    "./aliases": {
+      "default": "./dist/aliases.json"
+    },
+    "./tags": {
+      "default": "./dist/tags.json"
+    },
+    "./deprecations": {
+      "default": "./dist/deprecations.json"
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "llms.txt"
   ],
   "sideEffects": false,
   "scripts": {
     "generate": "tsx scripts/build-icons.ts",
-    "build": "pnpm run generate && tsup",
+    "build": "pnpm run generate && tsup && tsx scripts/build-metadata.ts",
     "test": "vitest run",
     "test:watch": "vitest",
     "prepublishOnly": "pnpm run build"