Permalink
Browse files

Update README.md

  • Loading branch information...
1 parent f1f72d5 commit 01ed9bf02adb8d6f13d1dd94374dacbacdb90e0f @hsnguyen committed on GitHub May 3, 2017
Showing with 26 additions and 0 deletions.
  1. +26 −0 README.md
View
@@ -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)

0 comments on commit 01ed9bf

Please sign in to comment.