Skip to content

Commit 039d319

Browse files
committed
docs(): Improve description
1 parent 79adff0 commit 039d319

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,18 @@
44

55
> Never worry about using the wrong heading level (`h1`, `h2`, etc.) in complex React apps!
66
7-
React-headings maintains the current heading level and prevents skipping levels no matter your component structure, [as required by WCAG](https://www.w3.org/WAI/tutorials/page-structure/headings/).
7+
React-headings maintains the proper hierarchy of headings for improved accessibility and SEO, no matter the component structure.
8+
9+
Logical hierarchy is required by [WCAG](https://www.w3.org/WAI/tutorials/page-structure/headings) and [Lighthouse SEO audits](https://web.dev/heading-order/).
810

911
## Table of contents
1012

1113
- [Demos](#demos)
1214
- [Highlights](#highlights)
1315
- [Installation](#installation)
1416
- [Examples](#examples)
17+
- [Changelog](#changelog)
18+
- [Contributing](#contributing)
1519

1620
## Demos
1721

@@ -27,7 +31,7 @@ React-headings maintains the current heading level and prevents skipping levels
2731
- Typed with TypeScript
2832
- Works with component libraries (Material UI, etc.)
2933
- Supports server-side rendering
30-
- Tiny (<1 kB minified + gzipped)
34+
- Under 1 kB minified & gzipped
3135
- Follows [semantic versioning](https://semver.org/)
3236

3337
## Installation

0 commit comments

Comments
 (0)