From: Haoqun Jiang <haoqunjiang@gmail.com>
Date: Tue, 27 Jul 2021 14:34:14 +0000 (+0800)
Subject: docs: a simple README, subject to further refinement
X-Git-Tag: v3.0.0-alpha.2~20
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6b216add4e380b9ef58cdd0ce31a3d40296eb0be;p=thirdparty%2Fvuejs%2Fcreate-vue.git

docs: a simple README, subject to further refinement
---

diff --git a/template/config/base/README.md b/template/config/base/README.md
index e69de29b..0c089225 100644
--- a/template/config/base/README.md
+++ b/template/config/base/README.md
@@ -0,0 +1,17 @@
+# Vue 3 + Vite
+
+This template should help get you started developing with Vue 3 in Vite.
+
+## Recommended IDE Setup
+
+[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur).
+
+## Type Support for `.vue` Imports in TS
+
+Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates.
+
+However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can run `Volar: Switch TS Plugin on/off` from VSCode command palette.
+
+### Customize configuration
+
+See [Vite Configuration Reference](https://vitejs.dev/config/).