From ca9bdfce410dd7b2d792710f85a7374be44af45a Mon Sep 17 00:00:00 2001 From: maxwondercorn Date: Thu, 6 Dec 2018 16:59:24 -0500 Subject: [PATCH] updates to readme --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 69996ce..705d9bb 100644 --- a/README.md +++ b/README.md @@ -13,12 +13,14 @@ This dictionary merges in the `en_US` Hunspell [dictionary](http://wordlist.sour ```sh npm add ember-dictionary ``` + +Note: Some `retext` plugins have dependencies that require Node v8. Specifically, the `remark-lint-no-dead-urls` plugin. + ## Configuration file To use the dictionary, add it to `.remarkrc.js` file with the appropriate configuration options ```js -// .remarkrc.js /* eslint-env node */ const unified = require("unified"); const read = require("fs").readFileSync; @@ -46,7 +48,8 @@ exports.plugins = [ ], "remark-preset-lint-consistent", "remark-preset-lint-recommended", - ["remark-lint-list-item-indent", "space"] + ["remark-lint-list-item-indent", "space"], + "remark-lint-no-dead-urls" ]; ```