feat(docs): Adds CHANGES.md and a note re draw order

Fixes #38
freelawproject · Oct 21, 2021 · 38e2508 · 38e2508
1 parent ca68fb8
commit 38e2508
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -0,0 +1,15 @@
+## Current
+
+### v0.2.1, 2021-10-21
+
+Fixes [issue 38](https://github.com/freelawproject/x-ray/issues/38) by adding
+analysis for the draw order of text and rectangles. This ensures that
+rectangles under text are not detected as bad redactions.
+
+
+## Past
+
+### v0.2.0, 2021-09-14
+
+Add support for bytes as input, making it easier to check files that are not
+on disk. This is common when downloading a file, for example.
diff --git a/README.md b/README.md
@@ -119,6 +119,7 @@ Things get tricky in a couple places:
  - letters without [ascenders][asc] are taller than they seem and might not be entirely under the rectangle
  - drawings in PDFs can contain multiple rectangles
  - text under redactions can be on purpose (like if it says "XXX" or "privileged", etc)
+ - text on top of rectangles is very common in forms, so we use the draw order of the PDF to detect this
 
 And so forth. We do our best.