@leta-io/icons 0.1.0 → 0.2.0

package/README.md

@@ -1,7 +1,8 @@
 # @leta-io/icons
 
-Material Symbols-backed icon registry for the LETA design system. Every icon
-ships both a filled and an outlined variant; outlined is the default.
+Material Symbols-backed icon registry for the LETA design system. Outlined is the
+default; 105 of the 261 icons also ship a filled variant, and names that have only
+one glyph fall back to it automatically, so `outlined` is always safe to pass.
 
 ```bash
 npm install @leta-io/icons
@@ -17,10 +18,15 @@ import { Icon } from '@leta-io/icons';
 ## Notes
 
 - `IconName` is exported as a union of all available names, so the set is
-  typo-proof at compile time.
-- The registry is a single module containing every icon, so importing one
-  currently pulls in all of them. Fine for an app; something to be aware of if
-  you are optimising a small bundle.
+  typo-proof at compile time. It is declared independently of the registry value,
+  so importing only the type costs you nothing — the published declarations are
+  ~6 KB, not the size of the glyph data.
+- The registry is a single module containing every icon, so importing one pulls in
+  all of them (~327 KB). That is a consequence of the API: icons are selected by
+  *name* at runtime, so the full set has to be present. Fine for an app; worth
+  knowing if you are optimising a small bundle.
+- Glyphs are stored pre-stripped of their `<svg>` wrapper — `Icon` supplies its own,
+  so it can control size, fill and aria consistently.
 
 Part of the LETA design system, alongside
 [`@leta-io/components`](https://www.npmjs.com/package/@leta-io/components) and