From d47ddb9265df055b29c8dff97b9c4e801926fc97 Mon Sep 17 00:00:00 2001
From: syy11cn <syy11cn@outlook.com>
Date: Wed, 6 Apr 2022 14:12:58 +0800
Subject: [PATCH] docs: add README.md

---
 README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d5c31e1
--- /dev/null
+++ b/README.md
@@ -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
+```