Skip to content

Commit d158573

Browse files
committed
Update README.md with project setup instructions
1 parent b9f86a3 commit d158573

File tree

1 file changed

+28
-5
lines changed

1 file changed

+28
-5
lines changed

README.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,31 @@
1-
# React + Vite
1+
# tailwind-react-boilerplate
22

3-
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
3+
This template should help get you started developing with React in Vite.
44

5-
Currently, two official plugins are available:
5+
## Customize configuration
66

7-
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
8-
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
7+
See [Vite Configuration Reference](https://vitejs.dev/config/).
8+
9+
## Project Setup
10+
11+
```sh
12+
npm install
13+
```
14+
15+
### Compile and Hot-Reload for Development
16+
17+
```sh
18+
npm run dev
19+
```
20+
21+
### Compile and Minify for Production
22+
23+
```sh
24+
npm run build
25+
```
26+
27+
### Lint with [ESLint](https://eslint.org/)
28+
29+
```sh
30+
npm run lint
31+
```

0 commit comments

Comments
 (0)