Skip to content

docs: Break up README.md + small fixes #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 21, 2018
Merged

docs: Break up README.md + small fixes #10

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
883a8a5
Break up long paragraphs
Kocal Jul 21, 2018
3838246
Fix « identifying »
Kocal Jul 21, 2018
3c94a47
Name browsers correctly
Kocal Jul 21, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,17 @@ Browser extension development plugin for vue-cli 3.x

## What does it do?
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).

This plugin adds a new command `ext-serve` to your vue applications.
This new command is only for running a livereload server while testing out your browser extension.

This removes the entrypoint of `main.js`, and as such will not scaffold a general vue app.
That behavior might change when support for a standalone tab application exists, but for now it is gone.
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.

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.

It makes some assumptions about your project setup.
I hope to be able to scaffold an app so that itentifying the below in unnecessary.
I hope to be able to scaffold an app so that identifying the below in unnecessary.

```
|- src/
Expand Down Expand Up @@ -46,8 +50,10 @@ This can be added to your vuejs project by one of the following methods:
## Usage
Running the Livereload server.
This will build and write to the local `dist` directory.

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.
You can then add this as an unpacked plugin to your browser, and will continue to update as you make changes.

**NOTE:** you cannot get HMR support in the popup window, however, closing and reopening will refresh your content.

```sh
Expand Down