diff options
Diffstat (limited to 'extension/README.md')
| -rw-r--r-- | extension/README.md | 61 |
1 files changed, 8 insertions, 53 deletions
diff --git a/extension/README.md b/extension/README.md index 36b26c2..a476f96 100644 --- a/extension/README.md +++ b/extension/README.md @@ -1,65 +1,20 @@ # @vnuge/nvault-extension -This template should help get you started developing a vue web extension in Vite. +This directory contains the source code for the NVault browser extension. Base template forked from [@samrum/vite-plugin-web-extension](https://github.com/samrum/vite-plugin-web-extension) ## Usage Notes +The .env file contains build configuration variables. API variables are used as defaults on extension startup. Most settings such as server base url and endpoint urls are configurable from the extension options page. -The extension manifest is defined in `src/manifest.js` and used by `@samrum/vite-plugin-web-extension` in the vite config. +### Install dependencies -Background, content scripts, options, and popup entry points exist in the `src/entries` directory. - -Content scripts are rendered by `src/entries/contentScript/renderContent.js` which renders content within a ShadowRoot -and handles style injection for HMR and build modes. - -Otherwise, the project functions just like a regular Vite project. - -To switch between Manifest V2 and Manifest V3 builds, use the MANIFEST_VERSION environment variable defined in `.env` - -HMR during development in Manifest V3 requires Chromium version >= 110.0.5480.0. - -Refer to [@samrum/vite-plugin-web-extension](https://github.com/samrum/vite-plugin-web-extension) for more usage notes. - -## Customize configuration - -See [Vite Configuration Reference](https://vitejs.dev/config/). - -## Project Setup - -```sh +```bash npm install ``` -## Commands -### Build -#### Development, HMR - -Hot Module Reloading is used to load changes inline without requiring extension rebuilds and extension/page reloads -Currently only works in Chromium based browsers. -```sh -npm run dev -``` - -#### Development, Watch - -Rebuilds extension on file changes. Requires a reload of the extension (and page reload if using content scripts) -```sh -npm run watch -``` - -#### Production - -Minifies and optimizes extension build -```sh +### Build the extension + +```bash npm run build ``` -### Load extension in browser - -Loads the contents of the dist directory into the specified browser -```sh -npm run serve:chrome -``` - -```sh -npm run serve:firefox -``` +Built extension output will be in the `dist` directory. You can zip the contents of this directory and load it into your browser.
\ No newline at end of file |