1 | English | [简体中文](./README_CN.md)
|
2 |
|
3 | vConsole
|
4 | ==============================
|
5 | [![npm version](https://badge.fury.io/js/vconsole.svg)](https://badge.fury.io/js/vconsole)
|
6 |
|
7 | A lightweight, extendable front-end developer tool for mobile web page.
|
8 |
|
9 |
|
10 | ## Features
|
11 |
|
12 | - View console logs
|
13 | - View network requests
|
14 | - Execute JS command manually
|
15 | - Custom plugin
|
16 |
|
17 |
|
18 | ## Usage
|
19 |
|
20 | Download the [latest release](https://github.com/WechatFE/vConsole/releases/latest). (DO NOT copy `dist/vconsole.min.js` in the dev branch)
|
21 |
|
22 | Or, install via npm:
|
23 |
|
24 | ```
|
25 | npm install vconsole
|
26 | ```
|
27 |
|
28 | Import `dist/vconsole.min.js` to your project:
|
29 |
|
30 | ```html
|
31 | <script src="path/to/vconsole.min.js"></script>
|
32 | <script>
|
33 | console.log('Hello world');
|
34 | // then tap vConsole button to see the log
|
35 | </script>
|
36 | ```
|
37 |
|
38 | See [Tutorial](./doc/tutorial.md) for more details.
|
39 |
|
40 |
|
41 | ## Preview
|
42 |
|
43 | ![](./example/snapshot/qrcode.png)
|
44 |
|
45 | [http://wechatfe.github.io/vconsole/demo.html](http://wechatfe.github.io/vconsole/demo.html)
|
46 |
|
47 | ![](./example/snapshot/log_panel.png)
|
48 |
|
49 |
|
50 | ## Documentation
|
51 |
|
52 | vConsole:
|
53 |
|
54 | - [Tutorial](./doc/tutorial.md)
|
55 | - [Public Properties & Methods](./doc/public_properties_methods.md)
|
56 | - [Helper Functions](./doc/helper_functions.md)
|
57 |
|
58 | Plugin:
|
59 |
|
60 | - [Plugin: Getting Started](./doc/plugin_getting_started.md)
|
61 | - [Plugin: Building a Plugin](./doc/plugin_building_a_plugin.md)
|
62 | - [Plugin: Event List](./doc/plugin_event_list.md)
|
63 |
|
64 |
|
65 | ## Plugins
|
66 |
|
67 | - [vConsole-resources](https://github.com/WechatFE/vConsole-resources)
|
68 | - [vConsole-sources](https://github.com/WechatFE/vConsole-sources)
|
69 |
|
70 |
|
71 | ## Changelog
|
72 |
|
73 | [CHANGELOG.md](./CHANGELOG.md)
|
74 |
|
75 |
|
76 | ## License
|
77 |
|
78 | The MIT License (http://opensource.org/licenses/MIT)
|