Added a "Current Status and Known Deficiencies" section

trailofbits · Oct 1, 2019 · e1ff6a2 · e1ff6a2
1 parent 1130be7
commit e1ff6a2
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -60,6 +60,11 @@ For an example that exercises all of these file formats, run:
 curl -v --silent https://www.sultanik.com/files/ESultanikResume.pdf | polyfile --html ESultanikResume.html - > ESultanikResume.json
 ```
 
+## Current Status and Known Deficiencies
+* The instrumented Kaitai Struct parser generator implementation has only been tested on the JPEG/JFIF grammar;
+  other KSY definitions may exercise portions of the KSY specification that have not yet been implemented
+* The JSON output schema will soon be replaced with the similar [SBuD](https://github.com/corkami/sbud) format
+
 ## License and Acknowledgements
 
 This research was developed by [Trail of