diff --git a/README_en.md b/README_en.md index 89d87fd..33d3d20 100644 --- a/README_en.md +++ b/README_en.md @@ -21,7 +21,7 @@ | `-c` | A string that contains `j`, `k` or `t`.
`j`: Use Japanese [compatibility ideographs](https://en.wikipedia.org/wiki/CJK_Compatibility_Ideographs).
`k`: Use Korean compatibility ideographs.
`t`: Use [CNS 11643 compatibility ideographs](https://en.wikipedia.org/wiki/CJK_Compatibility_Ideographs_Supplement). | `jkt` | | `-s ` | If `value` is `c`: Use only [UnihanCore2020](https://www.unicode.org/L2/L2019/19388-unihan-core-2020.pdf) characters on supplementary planes
If `value` is `*`: Use all characters on supplementary planes. | `c` | | `-i` | Convert other inherited variants (e.g. 秘 → 祕, 裡 → 裏). | `True` | - | `-I` | An iterable that contains `'aj1'`, and/or `'mj'`.
`'aj1'`: Use the [Adobe-Japan1 IVS](https://unicode.org/ivd/data/2022-09-13/IVD_Charts_Adobe-Japan1.pdf)
`'mj'`: Use the [Moji-Joho IVS](https://unicode.org/ivd/data/2022-09-13/IVD_Charts_Moji_Joho.pdf) | `False` | + | `-I` | An iterable that contains `'aj1'`, and/or `'mj'`.
`'aj1'`: Use the [Adobe-Japan1 IVS](https://unicode.org/ivd/data/2022-09-13/IVD_Charts_Adobe-Japan1.pdf).
`'mj'`: Use the [Moji-Joho IVS](https://unicode.org/ivd/data/2022-09-13/IVD_Charts_Moji_Joho.pdf). | `False` | ### Import module The `inheritedglyphs` module provides a single function `convert()` which converts a string to their inherited glyphs form. @@ -33,7 +33,7 @@ | `use_compatibility` | An iterable that contains `'j'`, `'k'`, and/or `'t'`.
`'j'`: Use Japanese [compatibility ideographs](https://en.wikipedia.org/wiki/CJK_Compatibility_Ideographs).
`'k'`: Use Korean compatibility ideographs.
`'t'`: Use [CNS 11643 compatibility ideographs](https://en.wikipedia.org/wiki/CJK_Compatibility_Ideographs_Supplement). | `'jkt'` | | `convert_inherited` | If `True`, it will convert other inherited variants (e.g. 祕 → 祕, 裡 → 裏). | `True` | | `use_supp` | Either be `False`, `'c'`, `'*'`.
`c`: in supplementary planes, only use [UnihanCore2020](https://www.unicode.org/L2/L2019/19388-unihan-core-2020.pdf) characters.
`'*'`: in supplementary planes, use all characters. | `'c'` | - | `use_ivs` | An iterable that contains `'aj1'`, and/or `'mj'`.
`'aj1'`: Use the [Adobe-Japan1 IVS](https://unicode.org/ivd/data/2022-09-13/IVD_Charts_Adobe-Japan1.pdf)
`'mj'`: Use the [Moji-Joho IVS](https://unicode.org/ivd/data/2022-09-13/IVD_Charts_Moji_Joho.pdf) | `False` | + | `use_ivs` | An iterable that contains `'aj1'`, and/or `'mj'`.
`'aj1'`: Use the [Adobe-Japan1 IVS](https://unicode.org/ivd/data/2022-09-13/IVD_Charts_Adobe-Japan1.pdf).
`'mj'`: Use the [Moji-Joho IVS](https://unicode.org/ivd/data/2022-09-13/IVD_Charts_Moji_Joho.pdf). | `False` | >>> from inheritedglyphs import * >>> string = '教育及青年發展局是澳門特區政府社會文化司成立的公共部門。'