improve docs

chdsbd · Apr 18, 2021 · 12acf21 · 12acf21
1 parent e95d9a3
commit 12acf21
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## 0.0.2 - 2021-04-17
+
+### Added
+
+- added more detail to installation instructions
+
 ## 0.0.1 - 2021-04-17
 
 ### Added

diff --git a/README.md b/README.md
@@ -20,11 +20,12 @@ $ npm i --save-dev eslint-plugin-better-dates
 
 ## Usage
 
-Add `@typescript-eslint/parser` to the `parser` field and `better-dates` to the plugins section of your `.eslintrc` configuration file, then configure the rules you want to use under the rules section.
+Add `@typescript-eslint/parser` to the `parser` field, your `tsconfig.json` relative path to `parserOptions.project`, and `better-dates` to the plugins section of your `.eslintrc` configuration file, then configure the rules you want to use under the rules section.
 
 ```json
 {
   "parser": "@typescript-eslint/parser",
+  "parserOptions": { "project": "./tsconfig.json" },
   "plugins": ["better-dates"],
   "rules": {
     "better-dates/ban-mutation": "error"
@@ -38,8 +39,8 @@ Add `@typescript-eslint/parser` to the `parser` field and `better-dates` to the
 
 **Key**: :wrench: = fixable, :thought_balloon: = requires type information
 
-| Name                                                     | Description                                               | :wrench: | :thought_balloon: |
-| -------------------------------------------------------- | --------------------------------------------------------- | -------- | ----------------- |
-| [`ban-date-mutation`](./docs/rules/ban-date-mutation.md) | Bans calling methods on `Date` that will mutate the date. |          | :thought_balloon: |
+| Name                                                                  | Description                                               | :wrench: | :thought_balloon: |
+| --------------------------------------------------------------------- | --------------------------------------------------------- | -------- | ----------------- |
+| [`better-dates/ban-date-mutation`](./docs/rules/ban-date-mutation.md) | Bans calling methods on `Date` that will mutate the date. |          | :thought_balloon: |
 
 > Project layout and configuration modified from [`typescript-eslint/eslint-plugin`](https://github.com/typescript-eslint/typescript-eslint/tree/26d71b57fbff013b9c9434c96e2ba98c6c541259/packages/eslint-plugin).
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-better-dates",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "ESLint plugin to prevent Date-related bugs.",
   "keywords": [
     "eslint",