aidos-ui 4.0.3 → 4.0.5

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) [2023] [Gerard Moreno-Torres Bertran]
+Copyright (c) 2023 Gerard Moreno-Torres Bertran
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,6 +1,6 @@
 # Aidos UI
 
-An opinionated React component library. Zero dependencies. Dark mode. Keyboard navigation.
+An opinionated React component library with dark mode, keyboard navigation, and Iconify-powered icons.
 
 [Documentation](https://aidos-ui.vercel.app)
 
@@ -13,7 +13,7 @@ npm install aidos-ui
 ## Setup
 
 ```tsx
-import { Providers, lightTheme, darkTheme } from 'aidos-ui/dist';
+import { Providers, lightTheme, darkTheme } from 'aidos-ui';
 
 function App() {
   return (
@@ -27,7 +27,7 @@ function App() {
 For Next.js SSR, add `JSServerStyles` to your `_document.tsx`:
 
 ```tsx
-import { JSServerStyles } from 'aidos-ui/dist';
+import { JSServerStyles } from 'aidos-ui';
 
 <Head>
   <JSServerStyles />
@@ -52,6 +52,26 @@ import { JSServerStyles } from 'aidos-ui/dist';
 
 **Other**: `Tabs`, `Calendar`, `DatePicker`, `Icon`, `DarkMode`
 
+## Icons
+
+Aidos uses [Iconify](https://iconify.design/) for icons. By default, missing icons are loaded asynchronously from Iconify's CDN. This keeps Aidos small, but requires network access and may cause icons to appear shortly after the initial render.
+
+For offline support and immediate rendering, install and register an icon set in your application:
+
+```bash
+npm install @iconify/react @iconify-json/fa
+```
+
+```tsx
+import { addCollection } from '@iconify/react';
+import faIcons from '@iconify-json/fa/icons.json';
+
+// Call once during application initialization.
+addCollection(faIcons);
+```
+
+Registering the collection bundles the icons with your application, so they no longer depend on Iconify's CDN. Other sets are available from the [Iconify icon sets directory](https://icon-sets.iconify.design/).
+
 ## Styling
 
 Components accept a `jss` prop for inline styles with automatic class generation: