mirror of
https://github.com/abhijithvijayan/web-extension-starter.git
synced 2026-01-30 09:48:12 +01:00
update README
This commit is contained in:
parent
ab27e3a0f6
commit
b0a1100d77
42
README.md
42
README.md
@ -4,6 +4,7 @@
|
|||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Cross Browser Support (Web-Extensions API)
|
- Cross Browser Support (Web-Extensions API)
|
||||||
|
- Browser Taylored Manifest generation
|
||||||
- Automatic build on code changes.
|
- Automatic build on code changes.
|
||||||
- Auto packs browser specific build files
|
- Auto packs browser specific build files
|
||||||
- ES6 modules support
|
- ES6 modules support
|
||||||
@ -31,6 +32,47 @@
|
|||||||
- `yarn run build:opera` to build opera extension.
|
- `yarn run build:opera` to build opera extension.
|
||||||
- `yarn run build` builds and packs extensions all at once to extension/ directory.
|
- `yarn run build` builds and packs extensions all at once to extension/ directory.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Update `src/manifest/index.js` file with browser vendor prefixed manifest keys
|
||||||
|
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
"__chrome__name": "SuperChrome",
|
||||||
|
"__firefox__name": "SuperFox",
|
||||||
|
"__edge__name": "SuperEdge",
|
||||||
|
"__opera__name": "SuperOpera"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
if the vendor is `chrome` this compiles to:
|
||||||
|
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
"name": "SuperChrome",
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Add keys to multiple vendors by seperating them with | in the prefix
|
||||||
|
|
||||||
|
```
|
||||||
|
{
|
||||||
|
__chrome|opera__name: "SuperBlink"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
if the vendor is `chrome` or `opera`, this compiles to:
|
||||||
|
|
||||||
|
```
|
||||||
|
{
|
||||||
|
"name": "SuperBlink"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
See the original [README](https://github.com/abhijithvijayan/wext-manifest) of wext-manifest package for more details
|
||||||
|
|
||||||
## Show your support
|
## Show your support
|
||||||
|
|
||||||
Give a ⭐️ if this project helped you!
|
Give a ⭐️ if this project helped you!
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user