Skip to content

Commit 276ec62

Browse files
authored
update readme 👍🏼
1 parent 8b7dd92 commit 276ec62

1 file changed

Lines changed: 18 additions & 12 deletions

File tree

README.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,8 @@
11
<div align="center">
2-
<a href="./sileo.mov">
3-
<video
4-
src="./sileo.mov"
5-
width="720"
6-
autoplay
7-
muted
8-
loop
9-
playsinline
10-
></video>
11-
</a>
122
<h1>Sileo</h1>
13-
<p>Physics-based toast notifications for React.</p>
14-
<p><a href="https://sileo.aaryan.design">Docs</a></p>
3+
<p>An opinionated, physics-based toast notifications for React.</p>
4+
<p><a href="https://sileo.aaryan.design">Try Out</a> &nbsp; / &nbsp; <a href="https://sileo.aaryan.design/docs">Docs</a></p>
5+
<video src="https://github.com/user-attachments/assets/a292d310-9189-490a-9f9d-d0a1d09defce"></video>
156
</div>
167

178
### Installation
@@ -20,4 +11,19 @@
2011
npm i sileo
2112
```
2213

14+
### Getting Started
15+
16+
```tsx
17+
import { sileo, Toaster } from "sileo";
18+
19+
export default function App() {
20+
return (
21+
<>
22+
<Toaster position="top-right" />
23+
<YourApp />
24+
</>
25+
);
26+
}
27+
```
28+
2329
For detailed docs, click here: https://sileo.aaryan.design

0 commit comments

Comments
 (0)