Skip to content

Commit b8a4497

Browse files
committed
docs: update contributing section
1 parent af02810 commit b8a4497

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

library/README.md

+20-4
Original file line numberDiff line numberDiff line change
@@ -115,10 +115,12 @@ export default function Index() {
115115

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

118-
- [**Library**](https://github.com/pheralb/toast/tree/main/library): React 18 with tsup.
118+
- [**Library**](https://github.com/pheralb/toast/tree/main/library): React 18 with tsup + Vitest for testing.
119119
- [**Website**](https://github.com/pheralb/toast/tree/main/website): Remix, shadcn/ui + Tailwind CSS + Radix & MDX.
120+
- [**Example**](https://github.com/pheralb/toast/tree/main/example): Next.js 14 /app project with Tailwind CSS to test the library.
120121

121122
1. [Click here to fork](https://github.com/pheralb/toast/fork) the repository.
123+
122124
2. Install dependencies:
123125

124126
```bash
@@ -129,14 +131,28 @@ npm install -g pnpm
129131
pnpm install
130132
```
131133

132-
3. Run monorepo:
134+
3. Commands:
133135

134-
```
136+
```bash
137+
# Run the development server:
135138
pnpm dev
139+
140+
# Build the docs & library:
141+
pnpm build
142+
143+
# Test the library:
144+
pnpm test
136145
```
137146

147+
- Open [`http://localhost:5173`](http://localhost:5173) to view the documentation website.
148+
- Open [`http://localhost:3000`](http://localhost:3000) to view the playground. Test the functionality of the library.
149+
138150
and create a pull request with your features or fixes 🚀✨.
139151

152+
<a href="https://github.com/pheralb/toast/graphs/contributors">
153+
<img src="https://contrib.rocks/image?repo=pheralb/toast" />
154+
</a>
155+
140156
## 📃 License
141157

142-
- [MIT License](https://github.com/pheralb/toast/blob/main/LICENSE).
158+
[MIT License](https://github.com/pheralb/toast/blob/main/LICENSE) - [**pheralb**](https://pheralb.dev) 2024.

0 commit comments

Comments
 (0)