Skip to content

Commit 7f9273e

Browse files
committed
updated README
1 parent 6d1fe9d commit 7f9273e

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# React Twinkle Text
2+
React twinkle text effect using Tailwind-compatible styles.
3+
4+
## Installation
5+
6+
```bash
7+
npm install react-twinkle-text
8+
```
9+
10+
## Usage
11+
### Normal Twinkle Text
12+
```jsx
13+
import { TwinkleText } from 'react-twinkle-text';
14+
15+
<TwinkleText className="text-gray-500">Hello World</TwinkleText>
16+
```
17+
18+
### Hover Twinkle Text
19+
```jsx
20+
import { TwinkleText } from 'react-twinkle-text';
21+
22+
<TwinkleText hover className="text-gray-500">Hello World</TwinkleText>
23+
```
24+
25+
### Group Hover Twinkle Text
26+
```jsx
27+
import { TwinkleText } from 'react-twinkle-text';
28+
29+
<div className="group">
30+
<TwinkleText groupHover className="text-gray-500">Hello World</TwinkleText>
31+
</div>
32+
```

0 commit comments

Comments
 (0)