Merge pull request #180 from razum2um/master

Note how to get a good initial dictionary
hcodes · Nov 1, 2021 · 78b3a59 · 78b3a59
2 parents 512d208 + 0af20ee
commit 78b3a59
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -83,6 +83,9 @@ Examples:<br/>
 `yaspeller --dictionary my_dict.json .`<br/>
 `yaspeller --dictionary my_dict.json:my_dict2.json .`
 
+If you have tons of markdown and introduce this linter, you're likely to want
+generation of initial dictionary with [yaspeller-dictionary-builder](https://github.com/razum2um/yaspeller-dictionary-builder),
+so one line will cover all word's forms.
 
 #### `--report <type>`
 Set type of report: `console`, `html`, `markdown`, `junit` or `json`.<br/>

diff --git a/README.ru.md b/README.ru.md
@@ -75,6 +75,10 @@ JSON-файл собственного словаря.
 `yaspeller --dictionary my_dict.json .`<br/>
 `yaspeller --dictionary my_dict.json:my_dict2.json .`
 
+Если у вас много md-файлов, и вы заносите линтер, то, возможно, вам пригодится
+[yaspeller-dictionary-builder](https://github.com/razum2um/yaspeller-dictionary-builder).
+Так вы сможете сгенерировать начальный словарь, где каждая строка будет объединять все словоформы.
+
 #### `--report <type>`
 Задать вид отчёта: `console`, `html`, `markdown`, `junit` или `json`.<br/>
 По умолчанию: `console`<br/>