A spritz like speed reader for the N1 client, inspired by @cameron 's squirt.io bookmarklet
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
resources
spec
stylesheets
.babelrc
.eslintrc
.gitignore
README.md
Squirt.js
package.json
squirt-icon.png

README.md

Speed Reader for Long Messages

Install

  • Click on the "Clone and Download Button"

  • Click on the Download ZIP option

  • Extract the ZIP file

  • Go to preferences in N1

  • Click on the "Plugins" tab

  • Click "Install Plugin"

  • Navigate to your downloads folder and select the "squirt-reader-N1-plugin-master" file and click "open"

  • Optional: set your defaults in the Squirt Preferences tab that should appear post install. This will set a minimum length of the e-mails that the Squirt reader will show up.

A lot TODO:

  • Parse e-mail html to string
  • build into nodes with ORP
  • display nodes
  • SquirtStore to handle state and events for the reader
  • Auto play at hard coded wpm
  • Styling for centered ORP letter
  • tests for SquirtStore methods
  • control component for play/pause
  • control component for jump forwards and backwards
  • key bindings for play pause jump etc
  • save settings in serialize and deserialize methods
  • transition reader in after hitting play