kitzo 3.1.0 → 3.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +24 -28
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,44 +1,40 @@
1
1
  # Kitzo
2
2
 
3
- A lightweight, production-ready React micro-utility library providing essential components, hooks, and functions for modern web applications.
3
+ Lightweight, production-ready React micro-utilities for modern web applications. Focus on simplicity, performance, and minimal footprint.
4
+
5
+ [Full Documentation & Demos](https://kitzo.vercel.app)
4
6
 
5
7
  ## Installation
6
8
 
7
9
  ```bash
8
10
  npm install kitzo
11
+ # or
12
+ pnpm add kitzo
9
13
  ```
10
14
 
11
- ## Core Features
12
-
13
- ### React Components
14
-
15
- Essential, accessible, and performance-optimized UI components:
16
-
17
- - **Toast**: A flexible notification system with support for custom positions, animations, and interaction patterns.
18
- - **Tooltip**: A contextual information component with smart positioning and customizable delay and animations.
19
-
20
- ### React Hooks
15
+ ## Features
21
16
 
22
- A collection of hooks to simplify common React application logic:
17
+ ### Components
18
+ - **Toast**: Smart notification system with flexible positioning.
19
+ - **Tooltip**: Contextual information with auto-positioning logic.
23
20
 
24
- - **useDebounce**: Delays value updates until a specified time has passed.
25
- - **useDebouncedCallback**: Returns a debounced version of a callback function.
26
- - **useThrottle**: Limits the execution rate of a frequently changing value.
27
- - **useLocalStorage**: Synchronizes state with browser local storage.
28
- - **useWindowSize**: Provides real-time window dimensions.
29
- - **useCopy**: Simplifies clipboard operations within components.
21
+ ### Hooks
22
+ - **useCopy**: Easy clipboard management.
23
+ - **useDebounce**: Debounc any value.
24
+ - **useDebouncedCallback**: Debounce function calls.
25
+ - **useLocalStorage**: State persistence via storage.
26
+ - **useOverlay**: History-synchronized overlay management.
27
+ - **useThrottle**: Limit execution rate.
28
+ - **useWindowSize**: Real-time window dimensions.
30
29
 
31
- ### Utility Functions
30
+ ### Utilities
31
+ - **copy**: Standalone programmatic clipboard copy.
32
32
 
33
- - **copy**: A standalone function for programmatically interacting with the system clipboard.
34
-
35
- ## Documentation
36
-
37
- For full usage guides, API references, and live demonstrations, visit the documentation site:
38
- [https://kitzo.vercel.app](https://kitzo.vercel.app)
39
-
40
- Check out the [root project](https://github.com/riyad-96/kitzo) for project-wide information.
33
+ ## See Also
34
+ - [Root Repository](https://github.com/riyad-96/kitzo)
35
+ - [Documentation](https://github.com/riyad-96/kitzo/tree/main/apps/docs)
41
36
 
42
37
  ## License
38
+ MIT
39
+
43
40
 
44
- This project is licensed under the MIT License.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "kitzo",
3
- "version": "3.1.0",
3
+ "version": "3.1.1",
4
4
  "description": "A lightweight production-ready React micro-utility library providing essential components, hooks, and functions for modern web applications.",
5
5
  "type": "module",
6
6
  "files": [