From b0a1100d77501678c30d287d78a784c0fc896c00 Mon Sep 17 00:00:00 2001 From: abhijithvijayan <34790378+abhijithvijayan@users.noreply.github.com> Date: Thu, 31 Oct 2019 08:28:54 +0530 Subject: [PATCH] update README --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/README.md b/README.md index 1b1bf28..0876c24 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ ## Features - Cross Browser Support (Web-Extensions API) +- Browser Taylored Manifest generation - Automatic build on code changes. - Auto packs browser specific build files - ES6 modules support @@ -31,6 +32,47 @@ - `yarn run build:opera` to build opera extension. - `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 Give a ⭐️ if this project helped you!