From ee0b12d356797a8ff7611496ae7e0ef54f562d51 Mon Sep 17 00:00:00 2001
From: Vojtech Moravec <vojtech.moravec.st@vsb.cz>
Date: Tue, 6 Oct 2020 10:28:13 +0200
Subject: [PATCH] Add compression extension info to README.

---
 README.md | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9ba28980..b3924ce0 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,17 @@
 # bigdataviewer-core
 [![](https://api.travis-ci.org/bigdataviewer/bigdataviewer-core.svg?branch=master)](https://travis-ci.org/bigdataviewer/bigdataviewer-core)
-[![Join the chat at https://gitter.im/bigdataviewer/bigdataviewer-core](https://badges.gitter.im/Join%20Chat.svg)](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
+[![Join the chat at https://gitter.im/bigdataviewer/bigdataviewer-core](https://badges.gitter.im/Join%20Chat.svg)](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.
-- 
GitLab