diff --git a/README.md b/README.md index 8219dd9..a0f5783 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,39 @@ # alignment.js -Javascript alignment viewer. +A suite of reusable [React](http://reactjs.org/) components for creating a variety of visualizations involving [multiple sequence alignments](https://en.wikipedia.org/wiki/Multiple_sequence_alignment). [View the live demo here](http://alignment.hyphy.org/). + +`alignment.js` can be used to create standard MSA viewers, utilizing functional programming to permit custom behavior such as highlighting individual sites: + +![alt text](images/standard.png) + +as well as scaffold viewers for next-generation sequencing data where a reference sequence stays fixed to the top: + +![alt text](images/scaffold.gif) + +and joint phylogeny/alignment viewers using packages like [phylotree.js](https://github.com/veg/phylotree.js): + +![alt text](images/phyalign.png) + +## Installation + +`alignment.js` is [available on NPM](https://www.npmjs.com/package/alignment.js) and can thus be installed with `npm` + +``` +npm install alignment.js +``` + +or `yarn` + +``` +yarn add alignment.js +``` ## Development Install a local copy: ``` -git clone https://github.com/stephenshank/alignment.js +git clone https://github.com/veg/alignment.js cd alignment.js yarn ``` diff --git a/images/phyalign.png b/images/phyalign.png new file mode 100644 index 0000000..effaf30 Binary files /dev/null and b/images/phyalign.png differ diff --git a/images/scaffold.gif b/images/scaffold.gif new file mode 100644 index 0000000..e80eb88 Binary files /dev/null and b/images/scaffold.gif differ diff --git a/images/standard.png b/images/standard.png new file mode 100644 index 0000000..fd35d0a Binary files /dev/null and b/images/standard.png differ diff --git a/package.json b/package.json index 0e92367..3080d75 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "alignment.js", - "version": "1.0.8", + "version": "1.0.9", "main": "lib/alignment.js", "license": "MIT", "dependencies": { diff --git a/src/scaffold_viewer.js b/src/scaffold_viewer.js index 048775d..d57ab68 100644 --- a/src/scaffold_viewer.js +++ b/src/scaffold_viewer.js @@ -90,7 +90,6 @@ class ScaffoldViewer extends Component { }, reference_sequence_data = this.sequence_data.slice(0,1), remaining_sequence_data = this.sequence_data.slice(1); - debugger; return (