Skip to content

Commit 260ed58

Browse files
committed
Improve README.md
1 parent 6f16e22 commit 260ed58

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,39 @@
11
# vue-web-extension-boilerplate
22

3+
This template allows you to quickly start a web extension containing:
4+
5+
- Boilerplate for `manifest.json` and `background.js` files, and for `icons` / `popup` folders,
6+
- Vue,
7+
- Vue-router (configurable),
8+
- Vuex (configurable),
9+
- Webpack,
10+
- CSS extraction,
11+
- A Bash script for removing `eval` usages to comply with the Content Security Policy of Chrome/Firefox web store, is automatically called at each build,
12+
- A Python script to automatically bundle your extension into a zip file.
13+
14+
## Requirements
15+
16+
- Node.js >= 6 and npm >= 3,
17+
- [git](https://git-scm.com),
18+
- [vue-cli](https://github.com/vuejs/vue-cli)
19+
320
## Usage
421

522
```bash
6-
$ npm install -g vue-cli
723
$ vue init kocal/vue-web-extension my-extension
824
$ cd my-extension
925
$ npm install
1026
$ npm run build
1127
```
1228

29+
### `npm run build`
30+
31+
Build the extension into `dist` folder.
32+
33+
### `npm run watch`
34+
35+
Watch modifications then run `npm run build`
36+
37+
### `python scripts/build-zip`
38+
39+
Build a zip-file following this format « `<name>`-`<version>`.zip », by reading `name` and `version` from `manifest.json` file.

0 commit comments

Comments
 (0)