Skip to content

Commit 1216cc9

Browse files
committed
docs: update readme
1 parent 49633c7 commit 1216cc9

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

library/README.md

+36-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,38 @@
1+
<div align="center">
2+
<a href="https://toast.pheralb.dev">
3+
<img
4+
src="https://raw.githubusercontent.com/pheralb/toast/main/website/public/images/logo.png?token=GHSAT0AAAAAACP44U4YKJ3KLY3DYHLRJPVWZSEQDXA"
5+
alt="@pheralb/toast"
6+
height="60"
7+
/>
8+
</a>
9+
<p>
10+
<b>
11+
An accessible and beautiful toast library for React.
12+
</b>
13+
</p>
14+
15+
<a href="https://toast.pheralb.dev/">Documentation</a>
16+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
17+
<a href="#-getting-started">Getting Started</a>
18+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
19+
<a href="#-contributing">Contribute</a>
20+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
21+
<a href="#-license">License</a>
22+
23+
</div>
24+
25+
<div align="center">
26+
27+
![esbuild Badge](https://img.shields.io/badge/esbuild-FFCF00?logo=esbuild&logoColor=000&style=flat)
28+
![npm bundle size](https://img.shields.io/bundlephobia/min/%40pheralb%2Ftoast)
29+
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fpheralb%2Ftoast%2Fbadge%3Fref%3Dmain&style=flat)](https://actions-badge.atrox.dev/pheralb/toast/goto?ref=main)
30+
![GitHub stars](https://img.shields.io/github/stars/pheralb/toast)
31+
![GitHub issues](https://img.shields.io/github/issues/pheralb/toast)
32+
![React Badge](https://img.shields.io/badge/React-61DAFB?logo=react&logoColor=000&style=flat)
33+
34+
</div>
35+
136
## ✨ Features
237

338
- [x] 🍂 Lightweight.
@@ -27,7 +62,7 @@ yarn add @pheralb/toast
2762
2. Add the toast provider:
2863

2964
```tsx
30-
// 📃 main.tsx
65+
// 📃 root.tsx
3166
import { ToastProvider } from '@pheralb/toast';
3267

3368
ReactDOM.createRoot(document.getElementById('root')!).render(

0 commit comments

Comments
 (0)