Skip to content

Commit 72a0d5a

Browse files
committed
docs: ✏️ Readme update
1 parent 06367e2 commit 72a0d5a

File tree

1 file changed

+45
-22
lines changed

1 file changed

+45
-22
lines changed

README.md

Lines changed: 45 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,42 @@
1-
# React Performance Hooks
2-
3-
[![NPM](https://img.shields.io/npm/v/@better-hooks/performance.svg)](https://www.npmjs.com/package/@better-hooks/performance)
4-
![npm bundle size](https://img.shields.io/bundlephobia/minzip/@better-hooks/performance)
5-
![npm type definitions](https://img.shields.io/npm/types/@better-hooks/performance)
6-
![NPM](https://img.shields.io/npm/l/@better-hooks/performance)
7-
![npm](https://img.shields.io/npm/dm/@better-hooks/performance)
8-
![GitHub stars](https://img.shields.io/github/stars/BetterTyped/react-performance-hooks?style=social)
9-
10-
> Debounce and throttle your functions to gain performance boost!
11-
12-
- [Better Typed](https://github.com/BetterTyped)
13-
14-
## Features
15-
16-
- :rocket: Simple, fast and light
17-
- :factory: Debounce and Throttle
18-
- 🪗 Lifecycle events handling
19-
20-
## Install
1+
# 🎊 React Performance Hooks
2+
3+
<p>
4+
<a href="https://bettertyped.com/">
5+
<img src="https://custom-icon-badges.demolab.com/static/v1?label=&message=BetterTyped&color=333&logo=BT" />
6+
</a>
7+
<a href="https://github.com/BetterTyped/react-performance-hooks">
8+
<img src="https://custom-icon-badges.demolab.com/github/stars/BetterTyped/react-performance-hooks?logo=star&color=118ab2" />
9+
</a>
10+
<a href="https://github.com/BetterTyped/react-performance-hooks/blob/main/License.md">
11+
<img src="https://custom-icon-badges.demolab.com/github/license/BetterTyped/react-performance-hooks?logo=law&color=yellow" />
12+
</a>
13+
<a href="https://github.com/semantic-release/semantic-release">
14+
<img src="https://custom-icon-badges.demolab.com/badge/semver-commitzen-e10079?logo=semantic-release&color=e76f51" />
15+
</a>
16+
<a href="https://github.com/BetterTyped/react-performance-hooks">
17+
<img src="https://custom-icon-badges.demolab.com/badge/typescript-%23007ACC.svg?logo=typescript&logoColor=white" />
18+
</a>
19+
<a href="https://www.npmjs.com/package/@better-hooks/performance">
20+
<img src="https://custom-icon-badges.demolab.com/bundlephobia/min/@better-hooks/performance?color=64BC4B&logo=package" />
21+
</a>
22+
<a href="https://www.npmjs.com/package/@better-hooks/performance">
23+
<img src="https://custom-icon-badges.demolab.com/npm/v/@better-hooks/performance.svg?logo=npm&color=E10098" />
24+
</a>
25+
</p>
26+
27+
## About
28+
29+
Debounce and throttle your functions to gain performance boost!
30+
31+
## Key Features
32+
33+
🔮 **Simple usage**
34+
35+
🚀 **Fast and light**
36+
37+
**Debounce and Throttle**
38+
39+
## Installation
2140

2241
```bash
2342
npm install --save @better-hooks/performance
@@ -29,7 +48,11 @@ or
2948
yarn add @better-hooks/performance
3049
```
3150

32-
## useDebounce
51+
---
52+
53+
## Examples
54+
55+
#### useDebounce
3356

3457
This hook allows debouncing of the given function.
3558

@@ -61,7 +84,7 @@ const MyComponent: React.FC = ({ delay }) => {
6184

6285
```
6386

64-
## useThrottle
87+
#### useThrottle
6588

6689
This hook allows debouncing of the given function.
6790

0 commit comments

Comments
 (0)