Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
danchitnis committed Feb 5, 2023
1 parent 4f870bc commit 48f1341
Showing 1 changed file with 9 additions and 13 deletions.
22 changes: 9 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![Npm Build](https:/danchitnis/webgl-plot/workflows/Npm%20Build/badge.svg) ![Yarn Build](https:/danchitnis/webgl-plot/workflows/Yarn%20Build/badge.svg) ![Code scanning](https:/danchitnis/webgl-plot/workflows/Code%20scanning/badge.svg) ![Build](https:/danchitnis/webgl-plot/workflows/Build/badge.svg) [![DOI](https://zenodo.org/badge/205590760.svg)](https://zenodo.org/badge/latestdoi/205590760)
![Npm Build](https:/danchitnis/webgl-plot/workflows/Npm%20Build/badge.svg) ![Yarn Build](https:/danchitnis/webgl-plot/workflows/Yarn%20Build/badge.svg) ![Code scanning](https:/danchitnis/webgl-plot/workflows/Code%20scanning/badge.svg) [![DOI](https://zenodo.org/badge/205590760.svg)](https://zenodo.org/badge/latestdoi/205590760)

## [Live demo 🚀](https://danchitnis.github.io/webgl-plot-examples/vanilla/)

Expand Down Expand Up @@ -27,6 +27,10 @@ multi-line high-performance 2D plotting library using native WebGL. The advantag

However notice that due to computation of the line data points, the performance of the thick lines is nearly _6 times slower_ than the normal lines. Only use thick lines when you need to see the lines clearly for example when highlighting a specific line. Further information can be found below. For benchmarking, see the [benchmark](https:/danchitnis/webgl-plot#benchmark) section.

## Version `next` coming soon 🎉

The next version is currently under development. More computation is moved to the GPU, significantly improving performance. These improvements specifically benefit the rolling plot and the scatter plot. However, these changes require a rewrite of the main library and migration to `webgl2`. The current version will remain as no maintenance is needed since it is based on pure javascript. See an example [here](https://codesandbox.io/s/wbglscatteracc-krsvmy).

## Python vesrion now released!! 🥳

See [pyglplot](https:/danchitnis/pyglplot) for the python equivalent of this library. However, please notice the python version is at its early stages.
Expand Down Expand Up @@ -147,22 +151,14 @@ For ES6 module and direct browser import use:
and in your-code.js:

```javascript
import {
WebglPlot,
WebglLine,
ColorRGBA,
} from "https://cdn.jsdelivr.net/gh/danchitnis/webgl-plot@master/dist/webglplot.esm.min.js";
import { WebglPlot, WebglLine, ColorRGBA } from "<http source>";
```

Thanks to [TimDaub](https:/TimDaub) for testing the ES6 module.

Notice that this method is only recommended for test and small codes.

## SkyPack

[Skypack](https://www.skypack.dev/view/webgl-plot) is a new exciting CDN for ESM Javascript. See the example below on how to use it:
You can use web-based bundlers such as [esm.sh](https://esm.sh/), [unpkng](https://unpkg.com/), [JSdeliver](https://www.jsdelivr.com/?docs=esm) ,and [jspm](https://jspm.org/) to import the library to get the appropriate `http source`. See an example here:
[JSfiddle](https://jsfiddle.net/danchitnis/tu1svwbp/)

Thanks to [TimDaub](https:/TimDaub) for testing the ES6 module.

## Benchmark

[Native Line](https://danchitnis.github.io/webgl-plot/benchmark/bench1.html) and
Expand Down

0 comments on commit 48f1341

Please sign in to comment.