Skip to content

Commit

Permalink
chore: cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
Kocal committed Jul 8, 2021
1 parent 0ae4571 commit df5138d
Show file tree
Hide file tree
Showing 6 changed files with 8,141 additions and 41,212 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ 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&utm_medium=referral&utm_content=Kocal/jsdoc-vuejs&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.

# This branch has been fixed to work with Vue 3 compiler-sfc
: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

Expand All @@ -22,10 +24,9 @@ JSDoc for VueJS
$ npm install --save-dev jsdoc jsdoc-vuejs
```

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

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

Expand Down
Loading

0 comments on commit df5138d

Please sign in to comment.