Skip to content

Commit 27d5dcb

Browse files
author
Eduardo García Maleta
committed
Update README
1 parent 3d6427d commit 27d5dcb

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Feather Icons for Qwik
1+
# <svg xmlns="http://www.w3.org/2000/svg" width="30" height="30" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-feather"><path d="M20.24 12.24a6 6 0 0 0-8.49-8.49L5 10.5V19h8.5z"/><line x1="16" y1="8" x2="2" y2="22"/><line x1="17.5" y1="15" x2="9" y2="15"/></svg> Feather Icons for Qwik
22

33
## What is Feather?
44

@@ -29,13 +29,13 @@ import { Icon } from "qwik-feather-icons";
2929
#### 2. Use
3030

3131
```tsx
32-
<ThumbsUpIcon/>
32+
<ThumbsUpIcon ...props />
3333
```
3434

3535
or
3636

3737
```tsx
38-
<Icon name="thumbs-up"/>
38+
<Icon name="thumbs-up" ...props />
3939
```
4040

4141
#### Props
@@ -66,6 +66,8 @@ export const DefaultIconProps: IconProps = {
6666
};
6767
```
6868

69+
> **Important:** in most cases you should use `<'Name'Icon/>` components (such as `<ThumbsUpIcon/>`), they are just a wrapper around the actual inline `<svg>`.
70+
6971
### License
7072

7173
This package is licensed under the [MIT License](https://github.com/yeyon/qwik-feather-icons/blob/main/LICENSE).

0 commit comments

Comments
 (0)