Skip to content

Commit

Permalink
docs: reference other doc files in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RebeccaStevens committed Jan 28, 2023
1 parent be97a13 commit 71bb407
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ An [ESLint](http://eslint.org) plugin to disable mutation and promote functional

[Any donations would be much appreciated](./DONATIONS.md). 😄

## Getting Started

[See our getting started guide](./GETTING_STARTED.md).

## Rulesets

The following rulesets are made available by this plugin:
Expand Down Expand Up @@ -165,6 +169,10 @@ These rules are what are included in the _external recommended_ rulesets.
- [@typescript-eslint/switch-exhaustiveness-check](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/switch-exhaustiveness-check.md)\
Although our [no-conditional-statements](./docs/rules/no-conditional-statements.md) rule also performs this check, this rule has a fixer that will implement the unimplemented cases which can be useful.

## Contributing

[See our contributing guide](./CONTRIBUTING.md).

## Prior work

This project started off as a port of [tslint-immutable](https://github.com/jonaskello/tslint-immutable) which was originally inspired by [eslint-plugin-immutable](https://github.com/jhusain/eslint-plugin-immutable).

0 comments on commit 71bb407

Please sign in to comment.