Firefox WebExtension that lets you share the current tab to frontpage.fyi with minimal effort.

Improved README.md

Changed files
+6 -34
+6 -34
README.md
··· 13 - Options page for storing your handle, app password, and optional PDS override. 14 - Convenience links to open frontpage.fyi or the options page from the pop-up. 15 16 - ### Repository layout 17 - 18 - ``` 19 - extension/ 20 - ├── background.js # Service worker for auth + ATProto requests 21 - ├── manifest.json # Manifest V3 definition 22 - ├── options.html/js # Credential management UI 23 - ├── popup.html/js # Submission UI 24 - └── styles.css # Shared styling for popup and options 25 - ``` 26 - 27 ### Prerequisites 28 29 - An ATProto account that Frontpage can read. 30 - An app password for that account (create one at <https://bsky.app/settings/app-passwords> or via your own PDS). 31 32 - ### Development install (temporary) 33 - 34 - 1. Open `about:debugging#/runtime/this-firefox`. 35 - 2. Click **Load Temporary Add-on…** and choose `manifest.json` inside the `extension/` directory. 36 - 3. Pin the “Frontpage” toolbar button if you want quick access. 37 - 38 - > This method is ideal while iterating; Firefox forgets the add-on on restart. 39 - 40 ### Install a packaged build 41 42 - After the GitHub Action finishes: 43 - 44 1. Visit the [Releases](https://github.com/antonmry/frontpage_firefox_plugin/releases) page and download the latest `frontpage-submitter-<version>.xpi` (signed) or `.zip` (unsigned) asset. 45 2. In Firefox, open `about:addons`, click the gear icon, and choose **Install Add-on From File…**. 46 3. Select the downloaded `.xpi` (preferred) or `.zip` to complete the installation and approve the permissions prompt. 47 - 48 - For ongoing self-distribution, host the generated `.xpi`/`.zip` on your own site, following Mozilla’s [self-distribution guide](https://extensionworkshop.com/documentation/publish/self-distribution/). 49 50 ### Configure credentials 51 ··· 75 - When packaging for distribution, zip the contents of the `extension/` directory (see workflow below). 76 - Licensed under the [Apache License 2.0](./LICENSE). 77 78 - ### Ship it on AMO 79 80 - - Provide the bundled icons from `extension/icons/` (16, 32, 48 and 128 px SVGs). 81 - - Zip the `extension/` directory (e.g. `cd extension && zip -r ../frontpage-submitter.zip .`). 82 - - Upload the archive to <https://addons.mozilla.org/developers/> and fill in the listing copy/screenshots. 83 - - AMO reviewers expect a concise summary; you can adapt the “Features” bullets above. 84 85 ### Self-distribution pipeline 86 ··· 96 - Mozilla requires every signed upload to have a unique version number. Bump `version` in `extension/manifest.json` before rerunning the workflow if you need a new signed package. 97 98 These artifacts can be hosted directly for self-distribution as described in the [Mozilla documentation](https://extensionworkshop.com/documentation/publish/self-distribution/). 99 - 100 - ### AMO listing reference 101 - 102 - - **Description**: “Quickly share the current tab to frontpage.fyi via ATProto. The extension auto-fills the title and link, handles ATProto login/refresh, and posts to Frontpage from your Firefox toolbar.” 103 - - **Tags**: `productivity`, `social`, `news`, `atproto` 104 - - **Contributions URL**: <https://github.com/antonmry/frontpage_firefox_plugin/>
··· 13 - Options page for storing your handle, app password, and optional PDS override. 14 - Convenience links to open frontpage.fyi or the options page from the pop-up. 15 16 ### Prerequisites 17 18 - An ATProto account that Frontpage can read. 19 - An app password for that account (create one at <https://bsky.app/settings/app-passwords> or via your own PDS). 20 21 ### Install a packaged build 22 23 1. Visit the [Releases](https://github.com/antonmry/frontpage_firefox_plugin/releases) page and download the latest `frontpage-submitter-<version>.xpi` (signed) or `.zip` (unsigned) asset. 24 2. In Firefox, open `about:addons`, click the gear icon, and choose **Install Add-on From File…**. 25 3. Select the downloaded `.xpi` (preferred) or `.zip` to complete the installation and approve the permissions prompt. 26 27 ### Configure credentials 28 ··· 52 - When packaging for distribution, zip the contents of the `extension/` directory (see workflow below). 53 - Licensed under the [Apache License 2.0](./LICENSE). 54 55 + ### Development install (temporary) 56 57 + 1. Open `about:debugging#/runtime/this-firefox`. 58 + 2. Click **Load Temporary Add-on…** and choose `manifest.json` inside the `extension/` directory. 59 + 3. Pin the “Frontpage” toolbar button if you want quick access. 60 + 61 + > This method is ideal while iterating; Firefox forgets the add-on on restart. 62 63 ### Self-distribution pipeline 64 ··· 74 - Mozilla requires every signed upload to have a unique version number. Bump `version` in `extension/manifest.json` before rerunning the workflow if you need a new signed package. 75 76 These artifacts can be hosted directly for self-distribution as described in the [Mozilla documentation](https://extensionworkshop.com/documentation/publish/self-distribution/).