Add README

BCCDC-PHL · Sep 28, 2023 · 81e06bc · 81e06bc
1 parent 06d62f5
commit 81e06bc
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,13 @@
+# snippy-variants
+
+Perform read mapping and variant calling using [snippy](https://github.com/tseemann/snippy).
+
+## Usage
+
+```
+nextflow run BCCDC-PHL/snippy-variants \
+  --ref </path/to/ref.fa> \
+  --fastq_input </path/to/fastqs> \
+  --outdir </path/to/output_dir>
+```
+