react-achievements 3.0.1 → 3.0.2
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.
- package/README.md +8 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,6 +6,14 @@ A flexible and extensible achievement system for React applications. This packag
|
|
|
6
6
|
<img src="https://media4.giphy.com/media/v1.Y2lkPTc5MGI3NjExbnMxdHVqanZvbGR6czJqOTdpejZqc3F3NXh6a2FiM3lmdnB0d3VoOSZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/LYXAZelQMeeYpzbgtT/giphy.gif" alt="React Achievements Demo" width="600" />
|
|
7
7
|
</p>
|
|
8
8
|
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install react-achievements react react-dom react-confetti react-modal react-toastify react-use
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Note: React and React DOM should be version 16.8.0 or higher. If you already have some of these packages installed, npm will skip them automatically.
|
|
16
|
+
|
|
9
17
|
## Quick Start
|
|
10
18
|
|
|
11
19
|
Here's a complete working example that shows automatic notifications and achievement tracking:
|
|
@@ -147,12 +155,6 @@ To allow users to view their achievement history, the package provides two essen
|
|
|
147
155
|
|
|
148
156
|
These components are the recommended way to give users access to their achievement history. While you could build custom UI using the `useAchievements` hook data, these components provide a polished, ready-to-use interface for achievement history.
|
|
149
157
|
|
|
150
|
-
## Installation
|
|
151
|
-
|
|
152
|
-
```bash
|
|
153
|
-
npm install react-achievements
|
|
154
|
-
```
|
|
155
|
-
|
|
156
158
|
## Basic Usage
|
|
157
159
|
|
|
158
160
|
```tsx
|