Skip to content

Commit

Permalink
updated readme to include install instruction (#7)
Browse files Browse the repository at this point in the history
* updated readme to include install instruction

* docs: updated readme to include install instruction

---------

Co-authored-by: Pedro Couto <[email protected]>
  • Loading branch information
Couto710 and Pedro Couto authored Nov 23, 2023
1 parent 695c6ac commit 2a7f0ca
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@ The `exclude` option in `tsconfig.json` makes tsc not directly check the file. U

## Usage

To install:

```bash
npm i @pixelmatters/ts-check-filter
```

To use the filter pipe the results into `ts-check-filter`:

```bash
Expand Down

0 comments on commit 2a7f0ca

Please sign in to comment.