Giter Club home page Giter Club logo

bookcision's Introduction

Bookcision

Install and learn more at the Project's Site

Created by Ryan & Alan Norbauer

Maintained by Readwise

When highlights and notes are created on any Kindle device, they are synced up to Amazon's cloud. These are then visible at read.amazon.com, but there is no reason to believe that Amazon will continue to provide this service forever, and our ability to work with text in that hosted browser-based environment is limited. This is a bookmarklet that permits one to excise notes/highlights from read.amazon.com. It yields a single page of cleanly styled notes/highlights, which can then be copied to one's clipboard and pasted into a local text repository (OneNote, Evernote, DevonThink, etc.). The highlights and notes can also be downloaded in a number of formats (e.g. JSON).

Forked from the original repo on bitbucket.

Contributing

Workflow

Setting up project for development

  1. git clone the project locally.
  2. Ensure you're using Node 0.10.35 (we recommend using nvm to do this)
  3. cd into directory and npm install

Development

  • grunt test - some unit tests which currently pass
  • grunt build - writes everything to /dest dir. dest/bookcision.js should be a working bookmarklet!
  • grunt lr - livereload development using a fake local environment, nothing on Amazon
  • grunt clean

Installing a module

rm npm-shrinkwrap.json & npm i [MODULE] --save & npm shrinkwrap

Releasing a new version (for maintainers)

  1. Bump the version number of Bookcision in package.json
  2. Run grunt build
  3. Copy dest/bookcision.js to dist/bookcision.js (replacing the old version)
  4. That's it! The new version will be at dist/bookcision.js and automatically updated via Github's CDN as soon as the change is merged into master. The bookcision website (where you install the bookmarklet) simply points at bookcision.readwise.io/dist/bookcision.js, which points at the github source code.

bookcision's People

Contributors

tristanh avatar arthaey avatar

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.