docs: a simple README, subject to further refinement

diff --git a/template/config/base/README.md b/template/config/base/README.md
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..0c089225209a2853569d75450e54b36f3f8d7355 100644 (file)
--- 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/).