Skip to content

Commit

Permalink
docs(): Improve description
Browse files Browse the repository at this point in the history
  • Loading branch information
alexnault committed Jan 12, 2021
1 parent 79adff0 commit 039d319
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,18 @@

> Never worry about using the wrong heading level (`h1`, `h2`, etc.) in complex React apps!
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/).
React-headings maintains the proper hierarchy of headings for improved accessibility and SEO, no matter the component structure.

Logical hierarchy is required by [WCAG](https://www.w3.org/WAI/tutorials/page-structure/headings) and [Lighthouse SEO audits](https://web.dev/heading-order/).

## Table of contents

- [Demos](#demos)
- [Highlights](#highlights)
- [Installation](#installation)
- [Examples](#examples)
- [Changelog](#changelog)
- [Contributing](#contributing)

## Demos

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

## Installation
Expand Down

0 comments on commit 039d319

Please sign in to comment.