Skip to content

Commit 4692bfc

Browse files
committed
docs: update readme
1 parent dd15f24 commit 4692bfc

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

library/README.md

+10-12
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
<div align="center">
2929

3030
![React Badge](https://img.shields.io/badge/Library-61DAFB?logo=react&logoColor=000&style=flat)
31-
![Astro Badge](https://img.shields.io/badge/Astro-BC52EE?logo=astro&logoColor=fff&style=flat)
31+
![Next.js Badge](https://img.shields.io/badge/Docs-000?logo=nextdotjs&logoColor=fff&style=flat)
3232
![Vitest Badge](https://img.shields.io/badge/Testing-6E9F18?logo=vitest&logoColor=fff&style=flat)
3333
![GitHub releases](https://img.shields.io/github/release/pheralb/toast)
3434
![npm bundle size](https://img.shields.io/bundlephobia/min/%40pheralb%2Ftoast)
@@ -77,9 +77,9 @@ yarn install @pheralb/toast
7777
```tsx
7878
// 📃 root.tsx
7979

80-
import { Toaster } from '@pheralb/toast';
80+
import { Toaster } from "@pheralb/toast";
8181

82-
ReactDOM.createRoot(document.getElementById('root')!).render(
82+
ReactDOM.createRoot(document.getElementById("root")!).render(
8383
<React.StrictMode>
8484
<App />
8585
<Toaster />
@@ -92,16 +92,16 @@ ReactDOM.createRoot(document.getElementById('root')!).render(
9292
```jsx
9393
// 📃 index.tsx
9494

95-
import { toast } from '@pheralb/toast';
95+
import { toast } from "@pheralb/toast";
9696

9797
export default function Index() {
9898
return (
9999
<>
100100
<button
101101
onClick={() =>
102102
toast.success({
103-
text: 'pheralb/toast',
104-
description: '✨ A beautiful toast library for React',
103+
text: "pheralb/toast",
104+
description: "✨ A beautiful toast library for React",
105105
})
106106
}
107107
>
@@ -126,9 +126,8 @@ export default function Index() {
126126

127127
[`pheralb/toast`](https://github.com/pheralb/toast) is a monorepo built with [Turbo](https://turbo.build/repo) and it uses:
128128

129-
- [**Docs**](https://github.com/pheralb/toast/tree/main/docs): Astro 5 with Content Layer, shadcn/ui + Tailwind CSS & MDX.
130-
- [**Library**](https://github.com/pheralb/toast/tree/main/library): React 18 with tsup + Lightning CSS + Vitest for testing.
131-
- [**Examples**](https://github.com/pheralb/toast/tree/main/examples): Apps to test the library.
129+
- [**Docs**](https://github.com/pheralb/toast/tree/main/docs): Next.js 15 + Content-Collections + MDX + shadcn/ui + Lucide + React-Symbols.
130+
- [**Library**](https://github.com/pheralb/toast/tree/main/library): React 19 with tsup + Lightning CSS + Vitest for testing.
132131

133132
1. [Click here to fork](https://github.com/pheralb/toast/fork) the repository.
134133

@@ -148,7 +147,7 @@ pnpm install
148147
# Run only documentation website:
149148
pnpm dev:docs
150149

151-
# Run all packages with examples:
150+
# Run all website + packages:
152151
pnpm dev
153152

154153
# Build the docs & library:
@@ -158,8 +157,7 @@ pnpm build
158157
pnpm test
159158
```
160159

161-
- 🧑‍🚀 Open [`http://localhost:4321`](http://localhost:4321) to view the **Astro** documentation website.
162-
- 🔎 Open [`http://localhost:3000`](http://localhost:3000) to view the **Next.js** playground. Only for test the functionality of the library.
160+
🧑‍🚀 Open [`http://localhost:3000`](http://localhost:4321) to view the **Next.js** documentation website.
163161

164162
and create a pull request with your features or fixes 🚀✨.
165163

0 commit comments

Comments
 (0)