Skip to content

Commit

Permalink
Add simple usage.
Browse files Browse the repository at this point in the history
  • Loading branch information
mayank1513 committed Jun 26, 2024
1 parent 47a9796 commit bdf125e
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,29 @@ or in your component
import "react-mouse-trail/dist/index.css";
```

Here's a revised version of the usage section:

## Usage

MouseTrail is simple to integrate:

```tsx
import { MouseTrail } from "react-mouse-trail";

export default function Layout() {
return (
<html lang="en" suppressHydrationWarning>
<body className={inter.className}>
{/* ... */}
<MouseTrail rgb={[1, 0, 0]} />
</body>
</html>
);
}
```

By default, the RGB value `[1, 0, 0]` represents the color red.

![Repobeats](https://repobeats.axiom.co/api/embed/016960ad97aa7b1abbdd9a615f5ffeb08d869cb6.svg "Repobeats analytics image")

## License
Expand Down

0 comments on commit bdf125e

Please sign in to comment.