From 7b1c59f62128cc8ff94ab909329bd10c7fd17983 Mon Sep 17 00:00:00 2001 From: abhijithvijayan <34790378+abhijithvijayan@users.noreply.github.com> Date: Fri, 17 Apr 2020 16:55:08 +0530 Subject: [PATCH] docs: update readme --- README.md | 55 ++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 38 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index c1cc728..b3b2a85 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,21 @@

🚀 web-extension-starter

TypeScript + React Version

Web Extension starter to build "Write Once Run on Any Browser" extension

+
+ + Travis Build + + + + DEPENDENCIES + + + LICENSE + + + TWEET + +

🙋‍♂️ Made by @abhijithvijayan

Donate: @@ -14,6 +29,8 @@

+❤️ it? ⭐️ it on [GitHub](https://github.com/abhijithvijayan/web-extension-starter) + 👶🏼 Looking for [Non React/TypeScript Version](https://github.com/abhijithvijayan/web-extension-starter/tree/master) instead? ## Features @@ -41,17 +58,20 @@ ## Use this template Create a new directory and run + ``` curl -fsSL https://github.com/abhijithvijayan/web-extension-starter/archive/react-typescript.tar.gz | tar -xz --strip-components=1 ``` ## 🚀 Quick Start -Ensure you have +Ensure you have + - [Node.js](https://nodejs.org) 10 or later installed - [Yarn](https://yarnpkg.com) v1 or v2 installed Then run the following: + - `yarn install` to install dependencies. - `yarn run dev:chrome` to start the development server for chrome extension - `yarn run dev:firefox` to start the development server for firefox addon @@ -75,22 +95,22 @@ Then run the following: - **Load extension in browser** - - ### Chrome +- ### Chrome - - Go to the browser address bar and type `chrome://extensions` - - Check the `Developer Mode` button to enable it. - - Click on the `Load Unpacked Extension…` button. - - Select your extension’s extracted directory. + - Go to the browser address bar and type `chrome://extensions` + - Check the `Developer Mode` button to enable it. + - Click on the `Load Unpacked Extension…` button. + - Select your extension’s extracted directory. - - ### Firefox +- ### Firefox - - Load the Add-on via `about:debugging` as temporary Add-on. - - Choose the `manifest.json` file in the extracted directory + - Load the Add-on via `about:debugging` as temporary Add-on. + - Choose the `manifest.json` file in the extracted directory - - ### Opera +- ### Opera - - Load the extension via `opera:extensions` - - Check the `Developer Mode` and load as unpacked from extension’s extracted directory. + - Load the extension via `opera:extensions` + - Check the `Developer Mode` and load as unpacked from extension’s extracted directory. ### Production @@ -99,8 +119,9 @@ Then run the following: Note: By default the `manifest.json` is set with version `0.0.0`. The webpack loader will update the version in the build with that of the `package.json` version. In order to release a new version, update version in `package.json` and run script. If you don't want to use `package.json` version, you can disable the option [here](https://github.com/abhijithvijayan/web-extension-starter/blob/e10158c4a49948dea9fdca06592876d9ca04e028/webpack.config.js#L79). - + ### Generating browser specific manifest.json + Update `source/manifest.json` file with browser vendor prefixed manifest keys ```js @@ -140,10 +161,10 @@ if the vendor is `chrome` or `opera`, this compiles to: See the original [README](https://github.com/abhijithvijayan/wext-manifest-loader) of `wext-manifest-loader` package for more details -## Show your support +## Bugs -Give a ⭐️ if this project helped you! +Please file an issue [here](https://github.com/abhijithvijayan/web-extension-starter/issues/new) for bugs, missing documentation, or unexpected behavior. -## Licence +## License -Code released under the [MIT License](LICENSE). +MIT © [Abhijith Vijayan](https://abhijithvijayan.in)