chore: update readme

moshensky · Sep 11, 2024 · e76e732 · e76e732
1 parent 6f104fc
commit e76e732
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/examples/ts-sample/README.md b/examples/ts-sample/README.md
@@ -1,4 +1,7 @@
-# Typescript sample
+# TypeScript Sample
 
-`mkSamplePdf` is a function that uses pdfmake to dynamically create pdfs.
-It has two tests that are using pdf-visual-diff. One test passes, because it's snapshot will match, the other fails.
+`mkSamplePdf` is a function that uses [pdfmake](http://pdfmake.org/) to dynamically create PDFs.
+It has two tests that use `pdf-visual-diff`:
+
+- One asserts that a snapshot matches.
+- The other asserts that it doesn't match.