docs(README): update props section

natemoo-re · Oct 22, 2024 · 63e93a3 · 63e93a3
1 parent 333f614
commit 63e93a3
Showing 1 changed file with 6 additions and 5 deletions.
diff --git a/packages/core/README.md b/packages/core/README.md
@@ -99,16 +99,17 @@ interface Props extends HTMLAttributes<"svg"> {
    * References a specific Icon
    */
   name: string;
+  "is:inline"?: boolean;
   title?: string;
-  size?: number;
-  width?: number;
-  height?: number;
+  size?: number | string;
+  width?: number | string;
+  height?: number | string;
 }
 ```
 
 The `Icon` also accepts any global HTML attributes and `aria` attributes. They will be forwarded to the rendered `<svg>` element.
-
-See the [`Props.ts`](./packages/core/lib/Props.ts) file for more details.
+https://github.com/natemoo-re/astro-icon/blob/main/packages/core/components/Icon.astro#L10-L17
+See the [`Props.ts`](./packages/core/components/Icon.astro#L10-L17) file for more details.
 
 ### Styling