README.md

bionode.io

bionode-fastq

Streamable FASTQ parser.

Install

You need to install the latest Node.JS first, please check nodejs.org or do the following:

# Ubuntu
sudo apt-get install npm
# Mac
brew install node
# Both
npm install -g n
n stable

To use bionode-fastq as a command line tool, you can install it globally with -g.

npm install bionode-fastq -g

Or, if you want to use it as a JavaScript library, you need to install it in your local project folder inside the node_modules directory by doing the same command without -g.

npm i bionode-fastq # 'i' can be used as shorcut to 'install'

Documentation

Check our documentation at doc.bionode.io or do:

bionode-fastq --help

Contributing

We welcome all kinds of contributions at all levels of experience, please read the CONTRIBUTING.md to get started!

Communication channels

Don't be shy! Come talk to us 😃

• Email [email protected]
• Chat room http://gitter.im/bionode/bionode
• IRC #bionode on Freenode
• Twitter @bionode