Skip to content

Commit 8e8aa06

Browse files
committed
Merge branch 'master' of github.com:InvenTorrey/jsdoc-vuejs
2 parents f18caca + df5138d commit 8e8aa06

File tree

6 files changed

+8141
-41212
lines changed

6 files changed

+8141
-41212
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ JSDoc for VueJS
77
[![codecov](https://codecov.io/gh/Kocal/jsdoc-vuejs/branch/master/graph/badge.svg)](https://codecov.io/gh/Kocal/jsdoc-vuejs)
88
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/850b7601f2bf4e8787a6aadbafa8afef)](https://www.codacy.com/app/kocal/jsdoc-vuejs?utm_source=github.com&utm_medium=referral&utm_content=Kocal/jsdoc-vuejs&utm_campaign=Badge_Grade)
99

10-
> A JSDoc plugin for listing props, data, computed data, and methods from *.vue files.
10+
A JSDoc plugin for listing props, data, computed data, and methods from `.vue` files.
1111

12-
# This branch has been fixed to work with Vue 3 compiler-sfc
12+
: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).
13+
14+
---
1315

1416
## Requirements
1517

@@ -22,10 +24,9 @@ JSDoc for VueJS
2224
$ npm install --save-dev jsdoc jsdoc-vuejs
2325
```
2426

25-
You also need to install `compiler-sfc` that match your Vue version:
27+
You also need to install `@vue/compiler-sfc` that match your Vue version:
2628

2729
```bash
28-
# if you use Vue 3+
2930
$ npm install --save-dev @vue/compiler-sfc
3031
```
3132

0 commit comments

Comments
 (0)