Skip to content

Commit 9e6f557

Browse files
authored
Merge pull request #10 from Kocal/chore/improve-readme
docs: Break up README.md + small fixes
2 parents d532a2d + 3c94a47 commit 9e6f557

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,17 @@ Browser extension development plugin for vue-cli 3.x
33

44
## What does it do?
55
This is intended to be a vue-cli@3.x replacement for [https://github.com/Kocal/vue-web-extension](https://github.com/Kocal/vue-web-extension).
6+
67
This plugin adds a new command `ext-serve` to your vue applications.
78
This new command is only for running a livereload server while testing out your browser extension.
9+
810
This removes the entrypoint of `main.js`, and as such will not scaffold a general vue app.
911
That behavior might change when support for a standalone tab application exists, but for now it is gone.
10-
Packaging and deploying will still be done with `yarn build` and zipping in up for chrome, firefox, or whichever other browser you wish to develop for.
12+
13+
Packaging and deploying will still be done with `yarn build` and zipping in up for Chrome, Firefox, or whichever other browser you wish to develop for.
14+
1115
It makes some assumptions about your project setup.
12-
I hope to be able to scaffold an app so that itentifying the below in unnecessary.
16+
I hope to be able to scaffold an app so that identifying the below in unnecessary.
1317

1418
```
1519
|- src/
@@ -46,8 +50,10 @@ This can be added to your vuejs project by one of the following methods:
4650
## Usage
4751
Running the Livereload server.
4852
This will build and write to the local `dist` directory.
53+
4954
This plugin will respect the `outputDir` setting, however it cannot read into passed CLI args, so if you require a custom output dir, be sure to add it in your `vue.config.js` file.
5055
You can then add this as an unpacked plugin to your browser, and will continue to update as you make changes.
56+
5157
**NOTE:** you cannot get HMR support in the popup window, however, closing and reopening will refresh your content.
5258

5359
```sh

0 commit comments

Comments
 (0)