README.md

bionode.io

# bionode-seq > Module for DNA, RNA and protein sequences manipulation.

Install

Install bionode-seq with npm:

$ npm install bionode

Alternatively, just include bionode-seq.min.js via a <script/> in your page.

Usage

You can require the module in Node.js or in the browser:

var seq = require('bionode-seq')

Please read the documentation for the methods exposed by bionode-seq.

Contributing

To contribute, clone this repo locally and commit your code on a separate branch.

Please write unit tests for your code, and check that everything works by running the following before opening a pull-request:

$ npm test

Please also check for code coverage:

$ npm run coverage

To rebuild and minify the module for the browser:

$ npm run build-browser

To rebuild the documentation using the comments in the code:

$ npm run build-docs

Check the issues for ways to contribute.

Contributors

Please see the file contributors.md for a list.

Support

If you find a bug please use the issues tracker to report it.
If you need help with this particular module, you can use the respective gitter chat room.
For general help or discussion about the bionode project, you can use the IRC channel #bionode on Freenode.

Contacts

Bruno Vieira <[email protected]> @bmpvieira

License

bionode-seq is licensed under the MIT license.
Check ChooseALicense.com for details.