Merge pull request #156 from darrenldl/dev

Added limitations section to README
darrenldl · Apr 6, 2019 · 0308b03 · 0308b03
2 parents 81abc3b + df35f51
commit 0308b03
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -37,6 +37,12 @@ blkar is overall based around [osbx](https://github.com/darrenldl/ocaml-SeqBox),
 - JSON mode
   - Outputs information in JSON format instead of human readable text, easy integration with scripts
 
+## Limitations
+
+- Only a single file is supported during encoding as SeqBox is a single-file archive format
+
+  - Blkar may still be usable as you can pipe stdout of other archivers, like tar, into blkar's stdin during encoding, and blkar can also pipe data out to stdout during decoding
+
 ## Goals
 
 As blkar is to be used largely as a backup utility, security/robustness of the code will be prioritised over apparent performance