diff --git a/README.md b/README.md index 9ba289802b8c995a28bb9bb2b0e03de37ad1dd70..b3924ce019502ec5c19ebb7024c6d1c51b4590bf 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ # bigdataviewer-core [](https://travis-ci.org/bigdataviewer/bigdataviewer-core) -[](https://gitter.im/bigdataviewer/bigdataviewer-core?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) ImgLib2-based viewer for registered SPIM stacks and more +[](https://gitter.im/bigdataviewer/bigdataviewer-core?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) + +ImgLib2-based viewer for registered SPIM stacks and more + + +## Usage: +``` +java -ea -jar bigdataviewer-core.jar <INPUT-FILE> +``` +Input file may be local XML file or dataset url on BigDataViwer Server, for example: http://127.0.0.1:8080/drosophila32. + +## QCMP Compression Extension +This extension adds one command line option `-qcmp`. If this option is specified, then the client request compressed data from the BigDataViewer web server. + +This extension doesn't limit functionality of original viewer application in any way.