From be2b4462b574d80ea6e82c532a9f8c9c0e1db17b Mon Sep 17 00:00:00 2001 From: Josh Stillman Date: Mon, 30 Sep 2024 14:52:45 -0400 Subject: [PATCH] update readme for 3.0.1 --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 77d8039..993644b 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,9 @@ ![](https://github.com/josh-stillman/lintier/blob/main/lintier.gif?raw=true) -Lintier works in React, Node, and other Typescript projects. It provides options to install [stylelint](https://stylelint.io/) for linting & formatting css, and [lint-staged](https://github.com/okonet/lint-staged#readme) for linting pre-commit. Lintier will install the dependencies, create the config files, and add scripts to your `package.json` file. +Lintier works in React, Node, and other Typescript projects. It lets you install [stylelint](https://stylelint.io/) for linting & formatting css, and [lint-staged](https://github.com/okonet/lint-staged#readme) for linting pre-commit. Lintier will install the dependencies, create the config files, and add scripts to your `package.json` file. -Lintier's goal is to provide a minimal foundation, allowing you to further customize the setup to fit your project's needs. +Lintier's goal is to provide a minimal foundation, letting you further customize the setup to fit your project's needs. ## Update for ESLint 9 @@ -34,8 +34,8 @@ Alternately, you can specify any of these options to skip the interactive prompt ## Troubleshooting and Pinned Versions -By default, lintier installs the latest version of the various dependencies, which means that breaking changes in those dependencies can break lintier. A weekly automated end-to-end test helps catch these changes. +By default, lintier installs the latest dependency versions, which means that breaking changes in those dependencies can break lintier. A weekly automated end-to-end test helps catch these changes. -If the latest versions aren't working, you can fall back to known working dependency versions by passing the `-p` flag when starting lintier. (Interactive mode will still start if this is the only flag passed). +If the latest dependency versions aren't working, you can fall back to the last-known working versions by passing the `-p` flag. (Interactive mode still starts if this is the only flag passed). The [list](./src/installDependencies/pinnedVersions.json) of known working versions is updated after each successful weekly test run. If you spot trouble, please open an issue in the GitHub repo.