Skip to content

Commit 7a5e045

Browse files
committed
docs(README): Refactor main README file
- Remove bundlephobia badges from readme files
1 parent 2c2af61 commit 7a5e045

File tree

5 files changed

+48
-12
lines changed

5 files changed

+48
-12
lines changed

README.md

Lines changed: 47 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,52 @@
1-
# Minwork - React
2-
Welcome to Minwork React related libraries. Below you can find a list of all npm packages available within this repository:
1+
# Minwork - React Libraries
2+
3+
![Minwork React Libraries](https://raw.githubusercontent.com/minwork/react/main/images/react-libraries-banner.webp)
4+
5+
# What is Minwork?
6+
Minwork is the personal brand of Krzysztof Kalkhoff. You can find more information about it on my [website](https://minwork.it).
7+
8+
# Libraries
39

410
## Hooks
5-
- [use-long-press](./packages/use-long-press/README.md) - React hook for detecting _click_, _tap_ or _point_ and _hold_ event
6-
- [use-double-tap](./packages/use-double-tap/README.md) - React hook for handling _double tap_ on mobile devices
7-
- [react-interval-hook](./packages/react-interval-hook/README.md) - React _self-correcting_ interval hook for precision timing
11+
12+
### Use Long Press
13+
![React Long Press Hook](https://raw.githubusercontent.com/minwork/react/main/packages/use-long-press/images/react-long-press-hook.webp)
14+
15+
![NPM Downloads](https://img.shields.io/npm/dm/use-long-press)
16+
[![npm](https://img.shields.io/npm/v/use-long-press)](https://www.npmjs.com/package/use-long-press)
17+
18+
> React hook for detecting _click_, _tap_ or _point_ and _hold_ event.
19+
20+
- [Readme](./packages/use-long-press/README.md)
21+
- [Demo (Storybook)](https://react-libraries-storybook.vercel.app/)
22+
- [Documentation](https://minwork.gitbook.io/long-press-hook)
23+
24+
### Use Double Tap
25+
26+
![React Double Tap Hook](https://raw.githubusercontent.com/minwork/react/main/packages/use-double-tap/images/react-double-tap-hook.webp)
27+
28+
![NPM Downloads](https://img.shields.io/npm/dm/use-double-tap)
29+
![npm](https://img.shields.io/npm/v/use-double-tap)
30+
31+
> React hook for handling _double tap_ on mobile devices
32+
33+
- [Readme](./packages/use-double-tap/README.md)
34+
- [Documentation](https://minwork.gitbook.io/double-tap-hook)
35+
36+
### React Interval Hook
37+
38+
![React Interval Hook](https://raw.githubusercontent.com/minwork/react/main/packages/react-interval-hook/images/react-interval-hook.webp)
39+
40+
![NPM Downloads](https://img.shields.io/npm/dm/react-interval-hook)
41+
[![npm](https://img.shields.io/npm/v/react-interval-hook)](https://www.npmjs.com/package/react-interval-hook)
42+
43+
> React _self-correcting_ interval hook for precision timing, augmented by management methods
44+
45+
- [Readme](./packages/react-interval-hook/README.md)
46+
- [Documentation](https://minwork.gitbook.io/react-interval-hook/)
847

948
## What's new
10-
If you're interested about the direction libraries above are heading check out [issues list](https://github.com/minwork/react/issues) to see what [new features](https://github.com/minwork/react/issues?q=is%3Aissue+is%3Aopen+label%3Afeature) are coming soon...
49+
If youre curious about the direction these libraries are heading, check out the [issues list](https://github.com/minwork/react/issues) to see what [new features](https://github.com/minwork/react/issues?q=is%3Aissue+is%3Aopen+label%3Afeature) are coming soon™️.
1150

12-
## Support
13-
If you like to support my work consider making a [donation](https://github.com/sponsors/minwork)
51+
# Support
52+
If you like to support my work consider making a [donation](https://github.com/sponsors/minwork).

images/react-libraries-banner.webp

43.5 KB
Loading

packages/react-interval-hook/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,12 @@
22

33
[![codecov](https://codecov.io/gh/minwork/react/branch/main/graph/badge.svg?token=2KPMMSLDOM)](https://codecov.io/gh/minwork/react)
44
![npm type definitions](https://img.shields.io/npm/types/react-interval-hook)
5-
[![npm bundle size](https://img.shields.io/bundlephobia/minzip/react-interval-hook)](https://bundlephobia.com/result?p=react-interval-hook)
65
![NPM Downloads](https://img.shields.io/npm/dm/react-interval-hook)
76
[![npm](https://img.shields.io/npm/v/react-interval-hook)](https://www.npmjs.com/package/react-interval-hook)
87

98
![React Interval Hook](https://raw.githubusercontent.com/minwork/react/main/packages/react-interval-hook/images/react-interval-hook.webp)
109

11-
> React hook for using **self-correcting** `setInterval`, augmented by management methods
10+
> React _self-correcting_ interval hook for precision timing, augmented by management methods
1211
1312
## Main features
1413

packages/use-double-tap/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33

44
[![codecov](https://codecov.io/gh/minwork/react/branch/main/graph/badge.svg?token=2KPMMSLDOM)](https://codecov.io/gh/minwork/react)
55
![npm type definitions](https://img.shields.io/npm/types/use-double-tap)
6-
![npm bundle size](https://img.shields.io/bundlephobia/min/use-double-tap)
76
![NPM Downloads](https://img.shields.io/npm/dm/use-double-tap)
87
![npm](https://img.shields.io/npm/v/use-double-tap)
98

packages/use-long-press/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
[![codecov](https://codecov.io/gh/minwork/react/branch/main/graph/badge.svg?token=2KPMMSLDOM)](https://codecov.io/gh/minwork/react)
44
![npm type definitions](https://img.shields.io/npm/types/use-long-press)
5-
![npm bundle size](https://img.shields.io/bundlephobia/min/use-long-press)
65
![NPM Downloads](https://img.shields.io/npm/dm/use-long-press)
76
[![npm](https://img.shields.io/npm/v/use-long-press)](https://www.npmjs.com/package/use-long-press)
87

0 commit comments

Comments
 (0)