Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jrobinso committed Sep 6, 2024
1 parent dd0345d commit c952301
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,19 @@ Below are examples and a quickstart guide. See the [developer documentation](ht

# Examples

***[Alignments](https://igv.org/web/release/3.0.3/examples/cram-vcf.html)***
***[Alignments](https://igv.org/web/release/3.0.5/examples/cram-vcf.html)***

***[Interactions](https://igv.org/web/release/3.0.3/examples/interact.html)***
***[Interactions](https://igv.org/web/release/3.0.5/examples/interact.html)***

***[Copy number](https://igv.org/web/release/3.0.3/examples/copyNumber.html)***
***[Copy number](https://igv.org/web/release/3.0.5/examples/copyNumber.html)***

***[Multiple regions](https://igv.org/web/release/3.0.3/examples/multi-locus.html)***
***[Multiple regions](https://igv.org/web/release/3.0.5/examples/multi-locus.html)***

***[Mutation Annotation Format (MAF)](https://igv.org/web/release/3.0.3/examples/maf-tcga.html)***
***[Mutation Annotation Format (MAF)](https://igv.org/web/release/3.0.5/examples/maf-tcga.html)***

***[Variant color options](https://igv.org/web/release/3.0.3/examples/variant-colors.html)***
***[Variant color options](https://igv.org/web/release/3.0.5/examples/variant-colors.html)***

***[More](https://igv.org/web/release/3.0.3/examples/)***
***[More](https://igv.org/web/release/3.0.5/examples/)***


# Quickstart
Expand All @@ -39,18 +39,18 @@ Below are examples and a quickstart guide. See the [developer documentation](ht
igv.js consists of a single javascript file with no external dependencies.

Pre-built files for script include, AMD, or CJS module systems (igv.min.js) and an ES6 module (igv.esm.min.js)
can be downloaded from [https://cdn.jsdelivr.net/npm/[email protected].3/dist/](https://cdn.jsdelivr.net/npm/[email protected].3/dist/).
can be downloaded from [https://cdn.jsdelivr.net/npm/[email protected].5/dist/](https://cdn.jsdelivr.net/npm/[email protected].5/dist/).

To import igv as an ES6 module

```javascript
import igv from "https://cdn.jsdelivr.net/npm/[email protected].3/dist/igv.esm.min.js"
import igv from "https://cdn.jsdelivr.net/npm/[email protected].5/dist/igv.esm.min.js"
```

Or as a script include (defines the "igv" global)

```html
<script src="https://cdn.jsdelivr.net/npm/[email protected].3/dist/igv.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected].5/dist/igv.min.js"></script>
```

Alternatively you can install with npm
Expand Down Expand Up @@ -91,7 +91,9 @@ a browser on a single alignment track opened at a specific locus:
})
```

For more details see the [Wiki](https://github.com/igvteam/igv.js/wiki) for full documentation of the API.
## Documentation

Full documentation of the igv.js API is available at [https://igv.org/doc/igvjs/](https://igv.org/doc/igvjs/).

## Development

Expand Down

0 comments on commit c952301

Please sign in to comment.