Supports Vue3 and the switch to compiler-sfc (#440)

BREAKING CHANGE: Drop Vue 2 support, add Vue 3 support, thanks to @DaveTorrey! Vue 2 support is still available on https://github.com/Kocal/jsdoc-vuejs/tree/3.x branch. Co-authored-by: Dave Torrey <[email protected]> Co-authored-by: Hugo Alliaume <[email protected]>
Kocal · Jul 8, 2021 · e73bd4f · e73bd4f
1 parent 713bc25
commit e73bd4f
Show file tree

Hide file tree

Showing 5 changed files with 2,007 additions and 2,115 deletions.
diff --git a/README.md b/README.md
@@ -7,24 +7,27 @@ JSDoc for VueJS
 [![codecov](https://codecov.io/gh/Kocal/jsdoc-vuejs/branch/master/graph/badge.svg)](https://codecov.io/gh/Kocal/jsdoc-vuejs)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/850b7601f2bf4e8787a6aadbafa8afef)](https://www.codacy.com/app/kocal/jsdoc-vuejs?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Kocal/jsdoc-vuejs&amp;utm_campaign=Badge_Grade)
 
-> A JSDoc plugin for listing props, data, computed data, and methods from *.vue files.
+A JSDoc plugin for listing props, data, computed data, and methods from `.vue` files.
+
+:warning: This branch is for Vue 3. If you still use Vue 2, please see [`3.x` branch](https://github.com/Kocal/jsdoc-vuejs/tree/3.x).
+
+---
 
 ## Requirements
 
 - Node 10+
-- Vue 2
+- Vue 3
 
 ## Installation
 
 ```bash
 $ npm install --save-dev jsdoc jsdoc-vuejs
 ```
 
-You also need to install `vue-template-compiler` that match your Vue version:
+You also need to install `@vue/compiler-sfc` that match your Vue version:
 
 ```bash
-# if you use Vue 2.5.21
-$ npm install --save-dev [email protected]
+$ npm install --save-dev @vue/compiler-sfc
 ```
 
 ## Usage