Skip to content

Commit 46b28af

Browse files
committed
Update readme
1 parent bcd87ce commit 46b28af

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

Diff for: readme.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# validate-html-nesting
22

3-
parent-child nesting validation for html elements
3+
A parent-child nesting validation library for HTML
44

5-
This is not a full blown HTML spec validation (intentionally). The parent-child nesting is considered valid if browser does not modify it, regardless of whether or not HTML spec considers it valid or invalid. So, the library is purely for detecting the kind of element nesting which result in altered DOM.
5+
This is not a full-blown HTML spec validation (intentionally). The parent-child nesting is considered valid if the Browser does not modify it, regardless of whether or not the HTML spec considers it valid or invalid. So, the library is purely for detecting the kind of element nesting which result in altered DOM.
66

77
### Example
88

@@ -13,7 +13,7 @@ This is not a full blown HTML spec validation (intentionally). The parent-child
1313
</p>
1414
```
1515

16-
browser modifies the above shown structure to below shown structure, which is why the library considers the `p > hr` nesting invalid.
16+
The Browser modifies the above-shown structure to the below-shown structure, which is why the library considers the `p > hr` nesting invalid.
1717

1818
```html
1919
<p>hello</p>
@@ -60,25 +60,24 @@ isValidHTMLNesting('div', 'a'); // true
6060

6161
## See also
6262

63+
- [eslint-plugin-validate-jsx-nesting](https://github.com/MananTank/eslint-plugin-validate-jsx-nesting) - ESLint plugin for JSX nesting validation
6364
- [babel-plugin-validate-jsx-nesting](https://github.com/MananTank/validate-jsx-nesting) - Compile time JSX nesting validation
6465

6566
<br/>
6667

6768
## Who is this library for?
6869

69-
This library is mostly useful for UI framework authors who need a way to make sure that DOM structure rendered by the browser matches the authored markup so that there's no unexpected behaviors
70-
71-
<br/>
70+
This library is mostly useful for UI framework authors who need a way to make sure that the DOM structure rendered by the browser matches the authored markup so that there are no unexpected behaviors
7271

7372
<br/>
7473

7574
## Test Suite
7675

77-
Refer to [validation.test.js](/tests/validation.test.js) to see full test suite
76+
Refer to [validation.test.js](/tests/validation.test.js) to see the full test suite
7877

7978
<br/>
8079

8180
## Contributing
8281

83-
PR's are welcome.
82+
PRs are welcome.
8483
Create an issue if you found a bug.

0 commit comments

Comments
 (0)