Skip to content

Commit f2b9f57

Browse files
refactor: update README.md with improved structure and content
1 parent f85570a commit f2b9f57

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

β€ŽREADME.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,19 @@
88

99
A React library to capture and display events in a user-friendly interface. This library provides components to log, view, and manage events in your React application.
1010

11+
- [πŸš€ Features](#-features)
12+
- [πŸ“¦ Installation](#-installation)
13+
- [βš™οΈ Compatibility](#️-compatibility)
14+
- [πŸ›  Usage](#-usage)
15+
- [Basic Setup](#basic-setup)
16+
- [πŸ“ Capturing Events](#-capturing-events)
17+
- [πŸ“Š Possible Use Cases](#-possible-use-cases)
18+
- [πŸ—‘ Clearing Events](#-clearing-events)
19+
- [πŸ“š Examples](#-examples)
20+
- [Basic Example](#basic-example)
21+
- [Advanced Example](#advanced-example)
22+
- [πŸ“„ License](#-license)
23+
1124
## πŸš€ Features
1225

1326
- Capture and display events in real-time
@@ -29,6 +42,13 @@ or yarn:
2942
yarn add react-capture-events
3043
```
3144

45+
## βš™οΈ Compatibility
46+
47+
The react-capture-events library is compatible with the following versions of React:
48+
49+
- React 17.x
50+
- React 18.x
51+
3252
## πŸ›  Usage
3353

3454
### Basic Setup

0 commit comments

Comments
Β (0)