From d9fd1612ed6738ec20335c763b907861c7153f85 Mon Sep 17 00:00:00 2001 From: Jeroen Engels Date: Sun, 9 Aug 2020 19:01:13 +0200 Subject: [PATCH] Talk about new-package and new-rule in the README --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 03a80fc0..f2eee149 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ npm install -g elm-review ``` You can also **try it out without installing it or configuring it** if you have Node.js installed. -All you need is to find a configuration on GitHub, and `elm-review` packages are encouraged to provide an example one, then run `elm-review` by specifying the name of the GitHub repository and the path to the configuration: +All you need is to find a configuration on GitHub, and note that `elm-review` packages are encouraged to provide an example one. Once you found the configuration, run `elm-review` by specifying the name of the GitHub repository and the path to the configuration: ```bash npx elm-review --template jfmengels/review-unused/example @@ -92,6 +92,8 @@ Before you start adding rules though, I suggest reading the rest of this documen You can write your own rule using this package's API and [`elm-syntax`](https://package.elm-lang.org/packages/stil4m/elm-syntax/7.1.0/). Check out the [`Review.Rule`](https://package.elm-lang.org/packages/jfmengels/elm-review/2.2.0/Review-Rule) documentation for how to get started. +**NOTE**: If you want to create a package containing `elm-review` rules, I highly recommend using the [CLI's](https://github.com/jfmengels/node-elm-review/) `elm-review new-package` subcommand. If you want to add/create a rule, then `elm-review new-rule` will help you get set up. + Here's an example of a rule that prevents a typo in a string that was made too often at your company. ```elm