Add stream usage to README

edawson · Nov 3, 2016 · 172817b · 172817b
1 parent 922ab3e
commit 172817b
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -30,7 +30,16 @@ This should build rkmh and its library dependencies (mkmh and murmur3).
 
 ### *NEW*: Stream
 rkmh can now stream reads through, using roughly constant memory. This is useful in read filtration workflows.
-This command functions almost identically to `classify` and performs the same read classification task.
+This command functions almost identically to `classify` and performs the same read classification task by default:
+
+```rkmh stream -r refs.fa -f reads.fa -k 12 -s 1000```  
+
+
+But also permits this:  
+
+```cat reads.fq | ./rmkmh stream -i -r refs.fa -k 12 -s 1000```  
+
+which should use less memory (because only one sketch per thread is kept in memory at any given time).
 
 The `-M` flag will have no effect (currently) on stream reads. I'm working on methods to prehash the read depth filters
 and pass them as files to rkmh.