Code Monkey home page Code Monkey logo

squirt's Introduction

Update: Squirt is now covered by an Apache license!

Apologies to those PRs that got hosed by decoupling squirt.io from the bookmarklet source--resubmit and I'll be happy to engage.

Squirt

A speed reading bookmarklet.

Features

  • automatically extracts text from blogs and articles
  • manual text selection
  • gorgeous
  • no external API dependencies

Sister Projects

squirt's People

Contributors

cameron avatar clarkf avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

squirt's Issues

Fail better

Some pages squirt simply does nothing -eg: https://d4l3.com/dreams

When that happens, at least throw an error or something so I know that you tried and just can't do that page. The first 3 pages I tried didn't work and I got no feedback and I wondered if I had installed it properly.

Cnet.com

Uncaught TypeError: undefined is not a function nr_loader.min.js:54
Uncaught TypeError: Cannot read property 'indexOf' of undefined loader.js?date=10162013:14
372
Uncaught TypeError: Cannot read property 'style' of null squirt.js:10
105
Uncaught TypeError: Cannot read property 'style' of null

Using Squirt many times breaks it

(Mac, Chrome)

If I select some words then run squirt on them, and then select different words and try run squirt on THAT, it doesn't work? It just shows as:

image

Close squirt when escape is pressed.

This is a really awesome, but I have some requests.

Clicking outside of the panel is the only way to close the overlay. It would be good if it could also be closed by pressing the escape button or something similar.

Pause (space bar) and other keybindings

It would be awesome to be able to control the reader with the keyboard, as it does not require moving your eyes.

  • space bar - pause / un-pause
  • up / right - faster
  • down / left - slower

Read articles from Pocket

Pocket is my preferred way to tag and later read articles on the web. It would be perfect to read those articles using Squirt, however when one tries to do so one is instead read a message about needing to enable javascript. :)

Squirt should just be able to look for div.reader_content element (or possibly better: div.text_body) and go from there. This should hopefully be an easy tweak. :)

Many thanks for Squirt, it's friggin awesome.

<3 Paul

JavaScript is not ignored

The code inside the following script tag:

<script type="text/javascript" language="javascript">var id2 = '0.3106187978178174';</script>

Was read to me as normal text by Squirt.

< li > tags - problematic when reading part of a page

< li > tags seem to be problematic when using the feature of only reading part of the page (i.e. highlighting text on the page). The following (spaces in li tag are intentional here):

< li>"This is the first item."< /li>
< li>"Followed by the second one."< /li>

... causes the following display:

item.
Followed

... in other words, "Followed" is displayed at the same time as "item" and it shows up underneath it. As an example, use the site shown in the squirt.io bookmarklet youtube video tutorial http://zenhabits.net and highlight the bullet-point list.

Squirt stops at words, ending with three dots...

If I select a text and within the text there are three dots, the last word squirt will show will be the word immediately before the last one. Example:

But what the heck is GitHub... and why are developers so excited about it?

If I select this sentence and click the bookmarklet the last word I will see will be "is" and then the pane will just stay empty and nothing will happen.

Wordpressq

How Can I add squirt to my wordpress website, thanks!

HTTPS support

Not sure how feasible this is. The bookmarklet does not function on HTTPS sites currently (in Chrome). This is due to Chrome's security policy of blocking insecure content. I believe a fix would be serving Squirt stuff over HTTPS?

No LICENSE.md file

Hi! Please could you choose a copyright license for Squirt? At the moment it's "closed source" because no license is chosen, would be awesome to have this under e.g. BSD license. Thanks!

hyphenation

can you please hyphenation for the most important languages? In particular long words are not so easy to grasp.

Keyboard navigation

  • Space to pause/play like in most video players.
  • Left arrow key to go one word back, right arrow key to go one word forward.

option to pause between paragraphs

It would be good if there were the option to pause or show down for a second or so between paragraphs. Right now it just zooms steadily through, while the content's context has changed, it can be slightly confusing...

Long words should to be slower

Hi there, I was just playing with squirt. It's fun, thanks for making it.

I noticed that long words are displayed for about the same time as short words. When they're long enough, I don't have enough time to read them. I think it's that I don't have enough time to scan my eyes over them.

The example I noticed was "hyperproductive"

Detect and pause for code examples

If there were a way to detect when code examples were being shown, a huge improvement would be to show the code example in its entirety and pause, allowing the user to continue reading after digesting the code example. Words are easy to garner meaning from in a flash, but code obviously requires symbols and has a lot more meaning packed into each word/line. This would make going through technical documentation UNBELIEVABLE.

Add time to read article

Given the WPM and the article/selection's word count it should be fairly simple to display how long it will take to read the article. This could go in the WPM section. To keep the design minimal something like "4m" or "2m 23s" could be used.

Find out a way to do this for PDFs...

One of the main pains in reading academic papers is that they are all in PDF. I have a lot of readings to do for a graduate course I'm taking, and being able to squirt through all of them via PDF would be a bliss...

yes, I can copy / paste into pastebin or something, but if there was a way to do it without a workaround it would have been awesome

Remember my WPM setting

Perhaps this is already extant, but simply doesn't work for me. Every time I hit the bookmarklet, it's set back to 400WPM — even though it should remember that I want it at 950.

Create master branch

I think this project should have a master branch with only the squirt source code. Therefore, people can work better while implement other functions such as browser plugins and improvements to the code.

Standard reading speed parametr.

It will be better if you will be add parametr to set defeault speed at bookmark-script, because everytime switch from 400 to 500 is terrible =(

i.e., a.m., p.m., e.g., et cetera

Initialisms, when separated by "." are threaded as separate words, which make them harder to understand (e.g.: e.g. becomes e. g. ;-) ).
Another use case are Initialisms that are not separated with dots but written all uppercase (e.g.: BTW ). Those are also harder to understand as they represent multiple words and you have to transcode them first.

Proposal: identify both patterns, display them as a single word, but increase the delay before the next word shows up.

Option for changing font type

Please add an option to change the font type. Right now we are able to use only one type of font and this is the main thing we see on the screen. Better font means better comprehension of the text.

It would be awesome to choose from some selected fonts and additional option to paste the url to the font file from google font repository or any other place.

Slow for numbers & dates

Visually there's not enough distinction between 5,000 and 6,000 or between January 3 & January 8 (and context doesn't help, like it does with words). Perhaps half-speed for any number blocks would help.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.