From 227b8aa82f4c120bbbd7e741c0ec0a5a1681c483 Mon Sep 17 00:00:00 2001
From: Andrew Yates <andrew.yates@gmail.com>
Date: Tue, 8 Jun 2021 11:13:10 +0200
Subject: [PATCH] add diffir-batch usage

---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
index b3644cd..c35935e 100644
--- a/README.md
+++ b/README.md
@@ -43,3 +43,9 @@ where the run files are 1 or 2 positional arguments indicating the run files to
 - `--metric <metric>`: the relevance metric to use with the qrel measure. Accepts [ir_measures](https://github.com/terrierteam/ir_measures) notation
 - `--topk <k>`: the number of queries to compare (as identified by the query contrast measure)
 - `--weights_1 <file>`, `--weights_2 <file>`: term importance files to use for snippet selection
+
+### Batch mode
+Use `diffir-batch` to generate comparison pages for every pair of run files in a directory.
+
+Usage: `diffir-batch <input directory> -o <output directory> <options>`
+where the `<options>` are those shown above.