Browse Source

added readme with packaging instructions

Brandon Wong 1 month ago
parent
commit
e5e1c81500
1 changed files with 34 additions and 0 deletions
  1. 34 0
      README.md

+ 34 - 0
README.md

@@ -0,0 +1,34 @@
+# Playlist Extension
+
+Firefox browser extension that manages video playlists and tracks playback history.
+
+## Loading for Development
+
+Load via `about:debugging` → "Load Temporary Add-on" → select `manifest.json`.
+
+## Packaging
+
+Create an `.xpi` file (the extension package format — just a ZIP with a different extension). Make sure `manifest.json` and other top-level files are at the root of the archive, not inside a subdirectory:
+
+```bash
+zip -r playlist.xpi manifest.json background.js content_scripts/ icons/ popup/ shared/
+```
+
+## Installing Permanently (without the store)
+
+### Option A: AMO Unlisted Signing (works on any standard Firefox)
+
+Mozilla will sign your extension without publishing it publicly:
+
+1. Create a developer account at addons.mozilla.org
+2. Submit the `.xpi` as **"unlisted"** (self-distribution, not public)
+3. Mozilla reviews it (usually auto-approved for unlisted) and returns a signed `.xpi`
+4. Install the signed `.xpi` permanently on any standard Firefox — no dev mode needed
+
+The extension never appears in the public store.
+
+### Option B: Unsigned `.xpi` on Firefox Developer Edition or Nightly
+
+Standard Firefox release enforces signature checks and ignores the bypass preference. **Firefox Developer Edition** and **Nightly** have `xpinstall.signatures.required` set to `false` by default, so they accept unsigned `.xpi` files as permanent installs.
+
+Drag-and-drop the `.xpi` into the browser, or go to `about:addons` → gear icon → "Install Add-on From File".