Skip to content

Commit e8a46ed

Browse files
committed
docs(readme): improve docs
1 parent cd3f25f commit e8a46ed

2 files changed

Lines changed: 8 additions & 2 deletions

File tree

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
This module allows you to pretty print the inner HTML
66
of `ComponentFixtures`, `DebugElements`, `NativeElements` or even plain HTML `strings` to the console.
7+
**This is very useful for debugging Angular component tests in Jest**
8+
9+
![logNgHTML](https://raw.githubusercontent.com/angular-extensions/pretty-html-log/master/images/before-after.png)
710

811
## Getting started
912

@@ -15,8 +18,11 @@ npm i -D @angular-extensions/pretty-html-log
1518
```
1619

1720
This module is best used with Angular and Jest. Create a
18-
`setupJest.ts` file in your `src` directory and import
19-
`@angular-extension/pretty-html-log`.
21+
`setupJest.ts` file in your `src` directory and add the following line:
22+
23+
```
24+
import @angular-extension/pretty-html-log
25+
```
2026

2127
This import adds a `logNgHTML` method to your console. You can then
2228
use this method during tests to pretty print `ComponentFixtures`,

images/before-after.png

1.29 MB
Loading

0 commit comments

Comments
 (0)