diff --git a/README.md b/README.md index 28a2679..b70aba5 100644 --- a/README.md +++ b/README.md @@ -1 +1,36 @@ -# 🚀 Web-extension-starter +

🚀 web-extension-starter

+

Web Extension starter to build "Write Once Write on any Browser" extension

+ +## Features + +- Cross Browser Support (Web-Extensions API) +- Automatic build on code changes. +- Auto packs browser specific build files +- ES6 modules support +- SASS styling + +## Browser Support + +| [![Chrome](https://raw.github.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png)](https://chrome.google.com/webstore/detail/kutt/pklakpjfiegjacoppcodencchehlfnpd) | [![Firefox](https://raw.github.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png)](https://addons.mozilla.org/firefox/addon/kutt/) | [![Opera](https://raw.github.com/alrra/browser-logos/master/src/opera/opera_48x48.png)](CONTRIBUTING.md#for-opera-users) | [![Yandex](https://raw.github.com/alrra/browser-logos/master/src/yandex/yandex_48x48.png)](https://chrome.google.com/webstore/detail/kutt/pklakpjfiegjacoppcodencchehlfnpd) | [![Brave](https://raw.github.com/alrra/browser-logos/master/src/brave/brave_48x48.png)](https://chrome.google.com/webstore/detail/kutt/pklakpjfiegjacoppcodencchehlfnpd) | [![vivaldi](https://raw.github.com/alrra/browser-logos/master/src/vivaldi/vivaldi_48x48.png)](https://chrome.google.com/webstore/detail/kutt/pklakpjfiegjacoppcodencchehlfnpd) | +![Edge](https://raw.github.com/alrra/browser-logos/master/src/edge/edge_48x48.png) | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| 49 & later ✔ | 52 & later ✔ | 36 & later ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ + +## 🚀 Quick Start + +- `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. +- `yarn run dev:opera` to start the development server for opera extension. +- `yarn run build:chrome` to build chrome extension. +- `yarn run build:firefox` to build firefox addon. +- `yarn run build:opera` to build opera extension. +- `yarn run build` builds and packs extensions all at once to extension/ directory. + +## Show your support + +Give a ⭐️ if this project helped you! + +## Licence + +Code released under the [MIT License](LICENSE).