igv 3.8.0 → 3.8.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -18,19 +18,19 @@ Below are examples and a quickstart guide. See the [developer documentation](ht
18
18
 
19
19
  # Examples
20
20
 
21
- ***[Alignments](https://igv.org/web/release/3.8.0/examples/cram-vcf.html)***
21
+ ***[Alignments](https://igv.org/web/release/3.8.2/examples/cram-vcf.html)***
22
22
 
23
- ***[Interactions](https://igv.org/web/release/3.8.0/examples/interact.html)***
23
+ ***[Interactions](https://igv.org/web/release/3.8.2/examples/interact.html)***
24
24
 
25
- ***[Copy number](https://igv.org/web/release/3.8.0/examples/copyNumber.html)***
25
+ ***[Copy number](https://igv.org/web/release/3.8.2/examples/copyNumber.html)***
26
26
 
27
- ***[Multiple regions](https://igv.org/web/release/3.8.0/examples/multi-locus.html)***
27
+ ***[Multiple regions](https://igv.org/web/release/3.8.2/examples/multi-locus.html)***
28
28
 
29
- ***[Mutation Annotation Format (MAF)](https://igv.org/web/release/3.8.0/examples/maf-tcga.html)***
29
+ ***[Mutation Annotation Format (MAF)](https://igv.org/web/release/3.8.2/examples/maf-tcga.html)***
30
30
 
31
- ***[Variant color options](https://igv.org/web/release/3.8.0/examples/variant-colors.html)***
31
+ ***[Variant color options](https://igv.org/web/release/3.8.2/examples/variant-colors.html)***
32
32
 
33
- ***[More](https://igv.org/web/release/3.8.0/examples/)***
33
+ ***[More](https://igv.org/web/release/3.8.2/examples/)***
34
34
 
35
35
 
36
36
  # Quickstart
@@ -39,18 +39,18 @@ Below are examples and a quickstart guide. See the [developer documentation](ht
39
39
  igv.js consists of a single javascript file with no external dependencies.
40
40
 
41
41
  Pre-built files for script include, AMD, or CJS module systems (igv.min.js) and an ES6 module (igv.esm.min.js)
42
- can be downloaded from [https://cdn.jsdelivr.net/npm/igv@3.8.0/dist/](https://cdn.jsdelivr.net/npm/igv@3.8.0/dist/).
42
+ can be downloaded from [https://cdn.jsdelivr.net/npm/igv@3.8.2/dist/](https://cdn.jsdelivr.net/npm/igv@3.8.2/dist/).
43
43
 
44
44
  To import igv as an ES6 module
45
45
 
46
46
  ```javascript
47
- import igv from "https://cdn.jsdelivr.net/npm/igv@3.8.0/dist/igv.esm.min.js"
47
+ import igv from "https://cdn.jsdelivr.net/npm/igv@3.8.2/dist/igv.esm.min.js"
48
48
  ```
49
49
 
50
50
  Or as a script include (defines the "igv" global)
51
51
 
52
52
  ```html
53
- <script src="https://cdn.jsdelivr.net/npm/igv@3.8.0/dist/igv.min.js"></script>
53
+ <script src="https://cdn.jsdelivr.net/npm/igv@3.8.2/dist/igv.min.js"></script>
54
54
  ```
55
55
 
56
56
  Alternatively you can install with npm
@@ -121,6 +121,14 @@ npm install
121
121
  npm run build
122
122
  ```
123
123
 
124
+ **Note**: igv.js has a large history with many commits which can make cloning and building the entire history time consuming.
125
+ To clone just the latest commit, use the ```--depth``` option, for example
126
+
127
+ ```
128
+ git clone --depth 1 https://github.com/igvteam/igv.js.git
129
+ ```
130
+
131
+
124
132
  This creates a dist folder with the following files
125
133
 
126
134
  * igv.js - UMDS file for script include, AMD, or CJS modules. A script include will define an "igv" global.