[#212] Add 'sign' script and update Firefox docs (#238)

* [#212] Install from file not working for Firefox

Add 'sign' command to package.json
- self-signs add on for Firefox as "unlisted"
- requires building the extension first…

Update documentation to outline the two options for installing the
add-on from file in Firefox.

Add separate section about manual installs to the README

Co-authored-by: Paul Meinhardt <paul@bitcrowd.net>

[fixes #212]

MAINTAINERS.md

@@ -0,0 +1,13 @@
+# Maintainers 👔
+
+Tips & tricks for maintainers of Tickety-Tick.
+
+## Sign add-on for Firefox
+
+Offering a (beta-) version for download requires self-signing the add-on through [addons.mozilla.org](https://extensionworkshop.com/documentation/publish/#distribute-your-signed-extension). This generates a `.xpi` for installing the extension in Firefox.
+
+Find the API credentials in 1Password and run:
+
+```shell
+yarn build:firefox && WEB_EXT_API_KEY=xxx WEB_EXT_API_SECRET=xxx yarn sign
+```

README.md

@@ -1,4 +1,6 @@
-# Tickety-Tick [![Build Status](https://circleci.com/gh/bitcrowd/tickety-tick.svg?style=svg)](https://circleci.com/gh/bitcrowd/tickety-tick)
+# ![ticket icon](./src/common/icons/icon-32.png) Tickety-Tick
+
+[![Build Status](https://circleci.com/gh/bitcrowd/tickety-tick.svg?style=svg)](https://circleci.com/gh/bitcrowd/tickety-tick)
 
 > #### How do you name this branch? What is the message for that commit?
 > A browser extension to generate these for you, based on the ticket you're working on.
@@ -46,12 +48,33 @@ Tickety-Tick is available for every major browser:
 - [Opera](./OPERA.md)
 - For Safari, you need to build it yourself ([see below](#safari))
 
+### Manual Installation
+
+Manually install the extension if you want to use an older version or a beta version.
+
+<details>
+<summary>Click here for instructions</summary>
+
+#### Chrome
+
+Download and unpack a `chrome.zip` file from the [releases](/~https://github.com/bitcrowd/tickety-tick/releases). Then navigate to the [chrome://extensions](//chrome://extensions) page, enable "Developer mode", press "Load unpacked extension" and point to the unpacked folder.
+
+#### Firefox
+
+Get a `tickety_tick-<version>.xpi` file from the [releases](/~https://github.com/bitcrowd/tickety-tick/releases) or sign a build yourself as per our [maintainer guide](./MAINTAINERS.md#sign-add-on-for-firefox). Then go to [about:addons](//about:addons), click on the small cog icon, select `Install Add-on From File…` and choose your `.xpi` file.
+
+#### Opera
+
+Download and unpack a `chrome.zip` file from the [releases](/~https://github.com/bitcrowd/tickety-tick/releases). Then navigate to the [opera://extensions](//opera://extensions) page, enable "Developer mode", press "Load unpacked extension" and point to the unpacked folder.
+</details>
+
 ## Keyboard Shortcuts
 
 | Shortcut                       | Description                       |
 |--------------------------------|-----------------------------------|
 | <kbd>Ctrl</kbd> + <kbd>t</kbd> | Open the extension's popup dialog |
 
+
 ## Building
 
 In order to build the extension from source, run:
@@ -86,7 +109,7 @@ Navigate to the [chrome://extensions](//chrome://extensions) page, enable "Devel
 
 If you just want to try out and debug the extension, go to [about:debugging#addons](//about:debugging#addons). Then press "Load Temporary Add-On" and select the built `manifest.json` from the `dist/firefox` extension directory.
 
-If you want to install this addon permanently, go to [about:addons](//about:addons) and click on the small cog icon. Select `Install Add-on From File...` and choose `dist/firefox`.
+If you want to install the extension permanently, you need to [enable unsigned add-ons](https://support.mozilla.org/en-US/kb/add-on-signing-in-firefox#w_what-are-my-options-if-i-want-to-use-an-unsigned-add-on-advanced-users). Then go to [about:addons](//about:addons), click on the small cog icon, select `Install Add-on From File…` and choose `dist/firefox`.
 
 ### Opera
 

package.json

@@ -17,6 +17,7 @@
     "open:firefox": "web-ext run --source-dir ./dist/firefox --pref startup.homepage_welcome_url=/~https://github.com/bitcrowd/tickety-tick",
     "bundle:chrome": "cross-env BUNDLE=true run-s build:chrome",
     "bundle:firefox": "cross-env BUNDLE=true run-s build:firefox",
+    "sign": "web-ext sign --source-dir ./dist/firefox --artifacts-dir ./dist --channel=unlisted",
     "lint": "eslint --ignore-path .gitignore --ext .js,.jsx .",
     "test": "jest",
     "checks": "run-s lint test"