react-achievements 1.3.3 → 1.3.5

package/README.md

@@ -3,6 +3,13 @@
 
 A flexible and customizable achievement system for React applications, perfect for adding gamification elements to your projects.
 
+[![React Achievements](https://img.youtube.com/vi/BWdtiE53S-8/maxresdefault.jpg)](https://youtu.be/BWdtiE53S-8)
+
+If you want to test the package, you can try it out here:
+
+https://stackblitz.com/edit/vitejs-vite-sccdux
+
+
 <h2 align="center">🚀 Installation</h2>
 
 Install `react-achievements` using npm or yarn:
@@ -65,42 +72,42 @@ import questMasterIcon from './icons/quest-master.png';
 const achievementConfig = {
   level: [
     {
-      check: (value) => value >= 10,
+      check: (value) => value >= 1,
       data: {
-        id: 'level_10',
+        id: 'level_1',
         title: 'Novice Adventurer',
-        description: 'Reached level 10',
+        description: 'Reached level 1',
         icon: levelUpIcon
       }
     },
     {
-      check: (value) => value >= 50,
+      check: (value) => value >= 5,
       data: {
-        id: 'level_50',
+        id: 'level_5',
         title: 'Seasoned Warrior',
-        description: 'Reached level 50',
+        description: 'Reached level 5',
         icon: levelUpIcon
       }
     }
   ],
   monstersDefeated: [
     {
-      check: (value) => value >= 100,
+      check: (value) => value >= 10,
       data: {
         id: 'monster_slayer',
         title: 'Monster Slayer',
-        description: 'Defeated 100 monsters',
+        description: 'Defeated 10 monsters',
         icon: monsterSlayerIcon
       }
     }
   ],
   questsCompleted: [
     {
-      check: (value) => value >= 50,
+      check: (value) => value >= 1,
       data: {
         id: 'quest_master',
         title: 'Quest Master',
-        description: 'Completed 50 quests',
+        description: 'Completed 1 quest',
         icon: questMasterIcon
       }
     }
@@ -191,6 +198,7 @@ export default Game;
 - Persistent Achievements: Unlocked achievements and metrics are stored in local storage, allowing players to keep their progress.
 - Achievement Gallery: Players can view all their unlocked achievements, encouraging completionism.
 - Confetti Effect: A celebratory confetti effect is displayed when an achievement is unlocked, adding to the excitement.
+- Local Storage: Achievements are stored locally on the device
 
 <h2 align="center">🔧 API</h2>
 
@@ -362,7 +370,12 @@ badgesButton: {
 
 ```
 
-This allows you to match the achievement system's look and feel to your game or application's theme.
+<h2 align="center">Resetting React Achievements</h2>
+
+The achievements are stored in local storage. In order to reset the package in your app, you need to delete the key-value pairs in local storage:
+
+![Key-Value pair delete image](./images/delete_local_storage.png)
+
 
 <h2 align="center">📄 License</h2>
 MIT