Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/TinyWebEx/AddonTemplate

A template for WebExtensions, so you can quickly start with one…
https://github.com/TinyWebEx/AddonTemplate

addon browser-addon browser-extension firefox firefox-addon firefox-extension firefox-webextension javascript template templates web-extension webextensions

Last synced: 5 days ago
JSON representation

A template for WebExtensions, so you can quickly start with one…

Awesome Lists containing this project

README

        

# THIS_ADDON_NAME_HUMAN

[![Mozilla Add-on version](https://img.shields.io/amo/v/THIS_ADDON_NAME_AMO.svg)](https://addons.mozilla.org/firefox/addon/THIS_ADDON_NAME_AMO/?utm_source=github.com&utm_medium=git&utm_content=badge-version&utm_campaign=github)
[![Mozilla Add-on downloads](https://img.shields.io/amo/d/THIS_ADDON_NAME_AMO.svg)](https://addons.mozilla.org/firefox/addon/THIS_ADDON_NAME_AMO/?utm_source=github.com&utm_medium=git&utm_content=badge-downloads&utm_campaign=github)
[![Mozilla Add-on users](https://img.shields.io/amo/users/THIS_ADDON_NAME_AMO.svg)](https://addons.mozilla.org/firefox/addon/THIS_ADDON_NAME_AMO/?utm_source=github.com&utm_medium=git&utm_content=badge-users&utm_campaign=github)
[![Mozilla Add-on stars](https://img.shields.io/amo/stars/THIS_ADDON_NAME_AMO.svg)](https://addons.mozilla.org/firefox/addon/THIS_ADDON_NAME_AMO/reviews/?utm_source=github.com&utm_medium=git&utm_content=badge-stars&utm_campaign=github)

This is a (Firefox) add-on (WebExtension) …

In contrast to many other add-ons, …

It is/has/features…

It is inspired by …. This extension only works with modern Firefox v60 or higher.

## Download

**[![Get it for Firefox!](https://extensionworkshop.com/assets/img/documentation/publish/get-the-addon-178x60px.dad84b42.png)](https://addons.mozilla.org/firefox/addon/THIS_ADDON_NAME_AMO/?utm_source=github.com&utm_medium=git&utm_content=download-button&utm_campaign=github)**

## In action…

![what shows this screencast description in alt text](assets/screencasts/someThing.gif)

See:
* [More screencasts](assets/screencasts)
* [More screenshots](assets/screenshots)

## Features
* Puts your privacy first! Privacy is the default here.
* Follows the [Firefox Photon Design](https://design.firefox.com/photon).
* Has a simple, but intuitive and usable User Interface.
* Translated in several languages already. [Contribute your own language!](CONTRIBUTING.md#Translations)
* Compatible with Firefox for Android
* […]

## Notes

### How to setup this template
0. Clone this repo.
1. Replace the following strings in all files of this dir accordingly:
* `THIS_ADDON_AUTHOR` -> `rugk`
* `THIS_ADDON_NAME_HUMAN` -> `My Awesome Add-on`
* `THIS_ADDON_NAME_SHORT_HUMAN` -> `Awesome Add-on`
* `THIS_ADDON_NAME_SHORT_TEC_HUMAN` -> `AwesomeAdd-on` (technical short name)
* `THIS_ADDON_NAME_AMO` -> `my-awesome-addon` (as in the URL of addons.mozilla.org)
* `THIS_ADDON_NAME_ID` -> `[email protected]`
* `THIS_ADDON_GITHUB_URL` -> `https://github.com/user/project`
2. Remove modules you may not need in [`.gitmodules`](.gitmodules).
3. Run `git submodule update --init --recursive` to initialize the remaining modules.
5. Remove this text here.
6. Remove the `.git` dir and run `git init` to get a fresh repo to start.

### LICENSE

The MIT license file included is also a template. You may choose any license.

This template itself is published under CC0, so do not have to attribute me for a simple template or so. That makes no sense. :)
Just remember that the TinyWebEx modules do have their own licenses, usually MIT licenses, so you need to include them, if you want to use these modules.



CC0



To the extent possible under law,

rugk

has waived all copyright and related or neighboring rights to
AddonTemplate.
This work is published from:

Germany
.