@robomonk/lector v0.0.5

The Lector Experience

🚀 Demo

Lector produces a reading enviroment, and summons a pointer that will help you read more efficient. It's sole purpose is to transfer a piece of text in the most efficient way possible to your melting brain.

To achieve this, Lector attempts to move the pointer precisely as your eyes would move on the text. This creates a dynamic between the pointer, your eyes and your mind. This dynamic can be expressed as "wiring in". Also known as super fucking focused on the text.

Get Started

Install

Use npm or yarn:

$ npm install @robomonk/lector

CDN:

<script> coming soon </script>

Set up

Plug & play

The simplest way you can hookup Lector to your document is like this:

lec = new Lector("#article")

This will trigger a pointer to the element's text, and generate a toolbar to control the pointer's settings.

Plug harder & play harder

You can declare Lector with many settings:

settings = {
  // these are the default values
  "toolbar": false,
  "topbar": false,
  "loop": false,
  "autostart": false,
  "interactive": true,
  "shortcuts": true, // if interactive is false, this option doesnt do anything
  "freadify": true // will convert plain text to .frd format (scroll to the .frd format section for more)
}

lec = new Lector("#article", settings)