docs: add README.md
This commit is contained in:
parent
cf44533d3a
commit
d47ddb9265
|
@ -0,0 +1,44 @@
|
|||
<div align="center">
|
||||
|
||||
# ReacTemplate
|
||||
|
||||
*`React` + `TypeScript` + `Vite` starting template.*
|
||||
|
||||
</div>
|
||||
|
||||
## Introduction
|
||||
|
||||
This is a starting template with following dependencies.
|
||||
|
||||
- ⚛️ `React v18.x`;
|
||||
- 📖 `TypeScript`;
|
||||
- ⚡ `Vite`;
|
||||
- 💡 `UnoCSS`;
|
||||
- 🚧 `ES Lint`;
|
||||
- 🏗️ `Vitest`;
|
||||
|
||||
## Usage
|
||||
|
||||
### With GitHub
|
||||
|
||||
When you create a repo, choose this repo as template.
|
||||
|
||||
### With `degit` (Recommended)
|
||||
|
||||
- Install `degit`
|
||||
|
||||
```bash
|
||||
npm i -g degit
|
||||
```
|
||||
|
||||
- Get this repo
|
||||
|
||||
```bash
|
||||
degit github:syy11cn/reactemplate
|
||||
```
|
||||
|
||||
- Initialize your git
|
||||
|
||||
```bash
|
||||
git init
|
||||
```
|
Loading…
Reference in New Issue