READMEに除外リストの項目を追加

[yasuda-shin]

概要

AmebaのVisionを除外リストにいれることを推奨する主旨をREADMEに追加してみました。
誰がみても実装イメージが湧いている文脈かどうかみていただけると。

[herablog]

Q: こり(allowlistConfigPaths)って設定ファイルへのpathを書くわけではなかったでしたっけ

[yasuda-shin]

そうでした。失礼しました。
質問返しで申し訳ないのですが、

  "filters": {
    "allowlist": {
      "allowlistConfigPaths": [
        "./allow.yml"
      ]
    }
  }

という感じで利用者側でymlファイルを用意してもらうか

  "filters": {
    "allowlist": {
      "allow": [
        "つくる、つむぐ、つづく、"
      ]
    }
  }

という感じでベタ書きにするか。
個人的には後者の方が利用イメージも湧きやすい気がしたのですが。
もしくは textlint-rule-preset-ameba 側からallow用のファイル提供とかできるともっといいものですかね？

[herablog]

今も lib/allow-ameba.yml は配信している気がするので、そこから読み込めるよ〜な感じにするとどうですかね。(node_modules配下になるのかな)

[yasuda-shin]

3fd6f48
node_modulesからの参照を追加しつつ文章も一部修正してみました。
手元の別リポジトリで試してみたら無事にVision除外されたのでnode_modulesからの参照でいけそうです🎉

[herablog]

commit messageのtype、どちらもdocsにしちゃってください！

[yasuda-shin]

docsにしつつコミット1つにまとめましたー。