diff --git a/README.md b/README.md index 42b45f934..3d69525b4 100644 --- a/README.md +++ b/README.md @@ -8,40 +8,44 @@ igv.js is an embeddable interactive genome visualization component developed by the [Integrative Genomics Viewer (IGV)](https://igv.org) team. -Below are examples and a quickstart guide. -See the [Wiki](https://github.com/igvteam/igv.js/wiki) for more documentation. +Below are examples and a quickstart guide. See the [Wiki](https://github.com/igvteam/igv.js/wiki) for more documentation. -[Release Notes](https://github.com/igvteam/igv.js/releases) - - # Examples -***[Alignments](https://igv.org/web/release/2.9.4/examples/cram-vcf.html)*** +***[Alignments](https://igv.org/web/release/2.10.0/examples/cram-vcf.html)*** -***[Interactions](https://igv.org/web/release/2.9.4/examples/arcs.html)*** +***[Interactions](https://igv.org/web/release/2.10.0/examples/interact.html)*** -***[Copy number](https://igv.org/web/release/2.9.4/examples/copyNumber.html)*** +***[Copy number](https://igv.org/web/release/2.10.0/examples/copyNumber.html)*** -***[Multiple regions](https://igv.org/web/release/2.9.4/examples/multi-locus.html)*** +***[Multiple regions](https://igv.org/web/release/2.10.0/examples/multi-locus.html)*** -***[Mutation Annotation Format (MAF)](https://igv.org/web/release/2.9.4/examples/maf-tcga.html)*** +***[Mutation Annotation Format (MAF)](https://igv.org/web/release/2.10.0/examples/maf-tcga.html)*** -***[Variant color options](https://igv.org/web/release/2.9.4/examples/variant-colors.html)*** +***[Variant color options](https://igv.org/web/release/2.10.0/examples/variant-colors.html)*** -***[More](https://igv.org/web/release/2.9.4/examples/)*** +***[More](https://igv.org/web/release/2.10.0/examples/)*** # Quickstart ## Installation -igv.js consists of a single javascript file with no external dependencies. To link directly to the current release copy this snippet +igv.js consists of a single javascript file with no external dependencies. -```html - +Pre-built files for ES5 (igv.min.js) and ES6 (igv.esm.min.js) +can be downloaded from [https://cdn.jsdelivr.net/npm/igv@2.10.0/dist/](https://cdn.jsdelivr.net/npm/igv@2.10.0/dist/). + +To import igv as an ES6 module + +```javascript +import igv from "https://cdn.jsdelivr.net/npm/igv@2.10.0/dist/igv.es6.min.js" ``` -Pre-built files for ES5 (igv.min.js) and ES6 (igv.esm.min.js) -can be downloaded from [https://cdn.jsdelivr.net/npm/igv@2.9.4/dist/](https://cdn.jsdelivr.net/npm/igv@2.9.4/dist/). +Or as a script include (defines the "igv" global) + +```html + +``` Alternatively you can install with npm @@ -154,6 +158,8 @@ igv.js require a modern web browser with support for Javascript ECMAScript 2015. igv.js is [MIT](/LICENSE) licensed. -# [_Release Notes_](https://github.com/igvteam/igv.js/releases) +### [Release Notes](https://github.com/igvteam/igv.js/releases) + + \ No newline at end of file