Skip to content

Latest commit

 

History

History
67 lines (49 loc) · 3.88 KB

README.md

File metadata and controls

67 lines (49 loc) · 3.88 KB
Raw

Omnivore List Popup Web Extension (Firefox & Chrome)

Warning

Omnivore is unfortunately shutting down soon. I am currently looking into other platforms to migrate this extension to (and keep most or ideally all of the current features). Get in touch if you have specific ideas or requests. RIP, Omnivore.

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

Screenshot of the extension running in a browser

Installation & Usage

Get the Add-on for Firefox Get the Add-on for Chrome

  1. Install the extension from the Firefox Extensions page or the Chrome Web Store.
  2. Get an Omnivore API Key through your Omnivore Account.
  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 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.

Development Commands

  • Run npm run dev to watch files for changes and start Firefox for debugging.
    • Run TARGET=chrome npm run dev to use Chrome
    • Run TARGET=vivaldi npm run dev to use Vivaldi
  • Run npm run format to format the code with Prettier.
  • Run npm run lint to lint the code with ESLint.
  • Run npm run build (or TARGET=chrome npm run build) to generate the output files in dist.

Releasing

  1. Run npm run create-releases to generate the extension archives in the root directory.
  2. Upload the Firefox release on https://addons.mozilla.org/developers/addon/omnivore-list-popup/
  3. Upload the Chrome release on https://chrome.google.com/webstore/devconsole
  4. Remove the locally-created files after uploading via npm run clean.

Contributing

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

Todos & Ideas

  • Add pagination to browse beyond 10 items (issue #9)
  • Add keyboard shortcuts for opening the popup and adding the current page to Omnivore
  • Improve generation of fallback images (sometimes broken or very low-contrast characters)
  • Cache API results for quicker load times
  • Indicate saving of new items when triggered via keyboard shortcut (e.g. via toolbar icon)
  • Add possibility to delete items (additionally to archiving)
  • Edit article info (title, description, dates, etc.)
  • Optionally load other sets like archived items (via saved searches dropdown?)
  • Improve onboarding, e.g. make it possible to enter API key in popup
  • Improve error handling
  • Use Omnivore’s savePage API instead of saveUrl (to capture page content directly)
  • 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.