Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.07 KB

README.md

File metadata and controls

40 lines (26 loc) · 1.07 KB

Counterpoint: Canvas Animation Library

This is a library to help people develop beautiful large-scale animated data visualizations using HTML5 Canvas and WebGL. See the docs >

Installation and Usage

Install Counterpoint from NPM:

npm install --save counterpoint-vis

You can use a static ESM version of the library in vanilla JS like so:

import { Mark, MarkRenderGroup } from 'https://cdn.jsdelivr.net/npm/counterpoint-vis@latest/dist/counterpoint-vis.es.js';

Dev Installation

Clone the repository, then from within the repo directory run:

cd counterpoint
npm install
npm run dev

This watches the library contents and rebuilds automatically to the counterpoint/dist directory.

You can run the examples by going into their respective directories, running npm install, then npm run dev.

Documentation Build

If not installed, install Ruby and Jekyll. Then cd into the docs directory and run:

bundle install
bundle exec jekyll serve