Omnivore List Popup Firefox Extension

Show a popup with a list of your Omnivore articles to quickly open or archive.

Installation & Usage

1. Get an Omnivore API Key through your Omnivore Account.
2. Install the extension from the Firefox Extensions page.
3. Go into the extension’s settings and paste your Omnivore API key.
4. Launch the extension by clicking the new "Omnivore List Popup" button in your Firefox extension toolbar/dropdown.
5. Optional: Add the extension to your always-visible toolbar.

Development Setup

1. Install the Node version defined in .nvmrc (e.g. with nvm use).
2. Install dependencies with npm install.
3. Run the build with npm run build to generate the output files.
4. Load the extension folder in Firefox.

Development Commands

• Run npm run dev to watch files for changes and re-run the build.
• Run npm run format to format the code with Prettier.
• Run npm run lint to lint the code with ESLint.

Releasing

Create an archive for a release in the Firefox extension store:

1. Run npm run create-release to generate the output files and create the extension archives.
2. Upload the archives on https://addons.mozilla.org/developers/

Contributing

If you have ideas or issues, please get in touch! You can either use GitHub issues or contact herrherrmann directly.

Todos & Ideas

• Chrome compatibility (check e.g. Hoverzoom for inspiration)
• Improve onboarding, e.g. make it possible to enter API key in popup
• Improve error handling
• Internationalization
• Cache list items locally for offline usage
• Highlight the popup button if the current page is added to Omnivore

Acknowledgements

• Thanks to the amazing In My Pocket extension for inspiring this project. 👏
• Thanks to the Omnivore team for the nice Pocket alternative and open API.
• Thanks to the Lucide project for the icon set.