@langchain/untitled-ui-icons 1.0.15 → 1.1.0

package/README.md

@@ -39,6 +39,32 @@ yarn build
 
 View available icons at: https://ideal-adventure-kgrlqgn.pages.github.io/
 
+## Usage in main repo
+
+### Line icons (default)
+
+```tsx
+import { ActivityHeartIcon } from "@langchain/untitled-ui-icons";
+
+// only svg
+<ActivityHeartIcon className="w-4 h-4" />
+// icon with standard size & padding from design system (recommended)
+<Icon icon={ActivityHeartIcon} size="sm" /> 
+```
+
+### Solid icons
+
+```tsx
+import { ActivityHeartSolidIcon } from "@langchain/untitled-ui-icons";
+
+// only svg
+<ActivityHeartSolidIcon className="w-4 h-4" />
+// icon with standard size & padding from design system (recommended)
+<Icon icon={ActivityHeartSolidIcon} size="sm" />
+```
+
+Both icon variants accept standard SVG props and inherit color via `currentColor`.
+
 ## TODO
 
 - Better handling of unexpected cases, malformed SVGs, incorrect naming convention, etc.