From fca4afea072c7d3b7cec2ed805f6452032c304b4 Mon Sep 17 00:00:00 2001
From: Viviana Monsalve <viviana.monsalve.a@gmail.com>
Date: Tue, 10 Oct 2023 19:09:08 -0500
Subject: [PATCH 1/2] Readme: formating changes

---
 README.md | 66 ++++++++++++++++++++++++++++++++-----------------------
 1 file changed, 39 insertions(+), 27 deletions(-)

diff --git a/README.md b/README.md
index 5a9ebab..3961256 100644
--- a/README.md
+++ b/README.md
@@ -66,55 +66,67 @@ usage: diffenator2 diff [-h] [--out OUT] [--imgs]
   --threshold THRESHOLD, -t THRESHOLD
 ```
 
-* The most typical usage is to compare two font families:
+#### Standard use: compare two families
 
-```
-# -fb == --fonts-before, -fa == --fonts-after
-diffenator2 diff -fb font1.ttf -fa font2.ttf -o out_dir
-```
+The most typical usage is to compare two font families:
 
-* Compare two font families and include a custom wordlist
+  ```
+  # -fb == --fonts-before, -fa == --fonts-after
+  diffenator2 diff -fb font1.ttf -fa font2.ttf -o out_dir
+  ```
 
-`diffenator2 diff -fb font1.ttf -fa font2.ttf --user-wordlist wordlist.txt -o out_dir`
+#### User Wordlist
 
-A wordlist is a csv file with the following columns:
+Compare two font families and include a custom wordlist
 
-`string, script, lang, ot features...`
+  `diffenator2 diff -fb font1.ttf -fa font2.ttf --user-wordlist wordlist.txt -o out_dir`
 
-script, lang and ot features are optional. An arbitrary number of ot features can be included e.g
+A wordlist could be
 
-```
-a,latn,dflt,ss01
-1/4,,,frac
-10/23,,,frac
-0123456789,,,numr,tnum
-```
+- A csv file with the following columns:
+
+  `string, script, lang, ot features...`
 
-* The `--filter-styles` option can be used to select which styles should be compared
+  script, lang and ot features are optional. An arbitrary number of ot features can be included e.g
+
+  ```
+  a,latn,dflt,ss01
+  1/4,,,frac
+  10/23,,,frac
+  0123456789,,,numr,tnum
+  ```
+
+#### Filter Styles
+
+The `--filter-styles` option can be used to select which styles should be compared
 
 For example, to only diff regular and bold styles:
 
-`diffenator2 diff -fb font1.ttf -fa font2.ttf --filter-styles "Regular|Bold"`
+  `diffenator2 diff -fb font1.ttf -fa font2.ttf --filter-styles "Regular|Bold"`
+
+- `--filter-styles` also accepts wildcards. To diff all Bold styles:
+
+  `diffenator2 diff -fb font1.ttf -fa font2.ttf --filter-styles "Bold*"`
 
-`--filter-styles` also accepts wildcards. To diff all Bold styles:
+#### Choose locations 
 
-`diffenator2 diff -fb font1.ttf -fa font2.ttf --filter-styles "Bold*"`
+`-s` is used to choose which locations of a variable font should be compared
 
-* `-s` is used to choose which locations of a variable font should be compared
+- The default is to compare named instances. To only compare masters:
 
-The default is to compare named instances. To only compare masters:
+  `diffenator2 diff -fb font1.ttf -fa font2.ttf -s masters`
 
-`diffenator2 diff -fb font1.ttf -fa font2.ttf -s masters`
+- To compare the cross product of min/default/max for each axis:
 
-To compare the cross product of min/default/max for each axis:
+  `diffenator2 diff -fb font1.ttf -fa font2.ttf -s cross_product`
 
-`diffenator2 diff -fb font1.ttf -fa font2.ttf -s cross_product`
+#### Choose specific characters 
 
-* `-ch` is used to select which characters to compare
+`-ch` is used to select which characters to compare
 
 To compare only ascii characters:
 
-`diffenator2 diff -fb font2.ttf -fa font2.ttf -ch "[!-~]"`
+  `diffenator2 diff -fb font2.ttf -fa font2.ttf -ch "[!-~]"`
 
 ### `proof`
 

From f2ea3669f6ed6edc5f5fd3f578797655944e94cf Mon Sep 17 00:00:00 2001
From: Viviana Monsalve <viviana.monsalve.a@gmail.com>
Date: Tue, 10 Oct 2023 19:25:32 -0500
Subject: [PATCH 2/2] Readme: paragraph option added to User Wordlist

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 3961256..5c2da30 100644
--- a/README.md
+++ b/README.md
@@ -96,6 +96,14 @@ A wordlist could be
   0123456789,,,numr,tnum
   ```
 
+- A .txt file with a paragraph of a desired sample to test specific words or languages. 
+  
+  Since a comma `,` is the key character to divide the provided sample into different lines, do not include commas if you want to see it as a single paragraph, e.g
+
+  ```
+  Trăm năm trong cõi người ta Ắ chữ Ắ tàichữ mệnh khéo là ghét nhau. Trải qua một Ắ cuộc bể dâu những điều trông thấy mà đau đớn lòng. Ắ Lạ gì bỉ sắc tư phong trời xanh quen thói má hồng đánh ghen. Cảo thơm lần giở trước đèn phong Tình có lục còn truyền sử xanh. Rằng năm Gia Tĩnh triều Minh bốn phương phẳng lặng hai kinh vững vàng. Có nhà viên ngoại họ Vương gia tư nghĩ cũng thường thường bực trung.
+  ```
+
 #### Filter Styles
 
 The `--filter-styles` option can be used to select which styles should be compared