docs(icons): Added @vibe/icons/meta to readme (#2712)

mondaycom · Jan 12, 2025 · 68d783d · 68d783d
1 parent a3da710
commit 68d783d
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/packages/icons/README.md b/packages/icons/README.md
@@ -31,6 +31,20 @@ import { Close } from "@vibe/icons/lazy";
 import { Close as CloseSvg } from "@vibe/icons/raw";
 ```
 
+#### Using Meta Information
+
+The meta export provides detailed metadata for each icon, including:
+
+- `name`: The name of the icon.
+- `file`: The SVG file name.
+- `description`: A description of the icon's purpose or usage.
+- `tags`: Associated tags as a comma-separated string.
+
+This metadata can be used to programmatically work with icons, such as building custom icon pickers or managing icons in your project.
+
+```javascript
+import iconsMetaData from "@vibe/icons/meta";
+```
 
 ## Peer dependencies