From 01ed9bf02adb8d6f13d1dd94374dacbacdb90e0f Mon Sep 17 00:00:00 2001 From: hsnguyen Date: Wed, 3 May 2017 22:57:40 +1000 Subject: [PATCH] Update README.md --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index cf6f042..8dac86e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,28 @@ # npBarcode Demultiplex the Nanopore barcoding data +### Introduction + +npBarcode is a tool to facilitate real-time demultiplexing for Nanopore sequencing +data. It was developed as part of [Japsa](https://github.com/mdcao/japsa) package where its source code and documentation reside. + +### Quick installation guide + +npBarcode includes command-line module *jsa.np.barcode* and also integrated into [npReader](https://github.com/mdcao/npReader). + +One may refer to [Japsa documentation](http://japsa.readthedocs.io/en/latest/) for instructions to install the packages of interest. + +### Documentation + +Detailed usage of npBarcode including setting up downstream analysis afterward will be updated in http://japsa.readthedocs.io/en/latest/tools/jsa.np.barcode.html + +General information of Japsa can be found on its [ReadTheDoc](http://japsa.readthedocs.org/en/latest/) + +### Reference + +If you find npBarcode useful for your research, please cite its publication: + +Application note to come... + +## License + +See [Japsa license](https://github.com/mdcao/japsa/blob/master/LICENSE.md)