| 1 | # vue-devtools
|
| 2 |
|
| 3 | [![Build Status][travis-image]][travis-url]
|
| 4 | [![NPM Downloads][downloads-image]][downloads-url]
|
| 5 | [![NPM Version][version-image]][version-url]
|
| 6 | [![License][license-image]][license-url]
|
| 7 | [![Dependency Status][dependency-image]][dependency-url]
|
| 8 | [![devDependency Status][devdependency-image]][devdependency-url]
|
| 9 | [![Code Style][style-image]][style-url]
|
| 10 |
|
| 11 | > An electron devtools extension for debugging Vue.js applications.
|
| 12 |
|
| 13 | ## Installation
|
| 14 |
|
| 15 | ```sh
|
| 16 | $ yarn add vue-devtools -D
|
| 17 |
|
| 18 | # or npm
|
| 19 | $ npm install vue-devtools --save-dev
|
| 20 | ```
|
| 21 |
|
| 22 | ## Usage
|
| 23 |
|
| 24 | ### Installing
|
| 25 |
|
| 26 | calling `install` in your `main.js`
|
| 27 |
|
| 28 | ```js
|
| 29 | const { app } = require('electron')
|
| 30 | app.on('ready', () => {
|
| 31 | // ...
|
| 32 | if (process.env.NODE_ENV !== 'production') {
|
| 33 | require('vue-devtools').install()
|
| 34 | }
|
| 35 | // ...
|
| 36 | })
|
| 37 | ```
|
| 38 |
|
| 39 | ### Uninstalling
|
| 40 |
|
| 41 | calling `uninstall` in your `main.js`
|
| 42 |
|
| 43 | ```js
|
| 44 | const { app } = require('electron')
|
| 45 | app.on('ready', () => {
|
| 46 | // ...
|
| 47 | if (process.env.NODE_ENV !== 'production') {
|
| 48 | require('vue-devtools').uninstall()
|
| 49 | }
|
| 50 | // ...
|
| 51 | })
|
| 52 | ```
|
| 53 |
|
| 54 | ## API
|
| 55 |
|
| 56 | ### install()
|
| 57 |
|
| 58 | Install Vue.js devtools in Electron devtools.
|
| 59 |
|
| 60 | ### uninstall()
|
| 61 |
|
| 62 | Uninstall Vue.js devtools in Electron devtools.
|
| 63 |
|
| 64 | ## Contributing
|
| 65 |
|
| 66 | 1. **Fork** it on GitHub!
|
| 67 | 2. **Clone** the fork to your own machine.
|
| 68 | 3. **Checkout** your feature branch: `git checkout -b my-awesome-feature`
|
| 69 | 4. **Commit** your changes to your own branch: `git commit -am 'Add some feature'`
|
| 70 | 5. **Push** your work back up to your fork: `git push -u origin my-awesome-feature`
|
| 71 | 6. Submit a **Pull Request** so that we can review your changes.
|
| 72 |
|
| 73 | > **NOTE**: Be sure to merge the latest from "upstream" before making a pull request!
|
| 74 |
|
| 75 | ## License
|
| 76 |
|
| 77 | [MIT](https://github.com/vuejs/vue-devtools/blob/master/LICENSE) © [vuejs/vue-devtools](https://github.com/vuejs/vue-devtools)
|
| 78 |
|
| 79 | [MIT](LICENSE) © [汪磊](https://zce.me/)
|
| 80 |
|
| 81 |
|
| 82 |
|
| 83 | [travis-image]: https://img.shields.io/travis/zce/vue-devtools.svg
|
| 84 | [travis-url]: https://travis-ci.org/zce/vue-devtools
|
| 85 | [downloads-image]: https://img.shields.io/npm/dm/vue-devtools.svg
|
| 86 | [downloads-url]: https://npmjs.org/package/vue-devtools
|
| 87 | [version-image]: https://img.shields.io/npm/v/vue-devtools.svg
|
| 88 | [version-url]: https://npmjs.org/package/vue-devtools
|
| 89 | [license-image]: https://img.shields.io/npm/l/vue-devtools.svg
|
| 90 | [license-url]: https://github.com/zce/vue-devtools/blob/master/LICENSE
|
| 91 | [dependency-image]: https://img.shields.io/david/zce/vue-devtools.svg
|
| 92 | [dependency-url]: https://david-dm.org/zce/vue-devtools
|
| 93 | [devdependency-image]: https://img.shields.io/david/dev/zce/vue-devtools.svg
|
| 94 | [devdependency-url]: https://david-dm.org/zce/vue-devtools?type=dev
|
| 95 | [style-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg
|
| 96 | [style-url]: http://standardjs.com
|