From 1d06aeef01661ba9fb11f9f6ff40b6edd2ceb034 Mon Sep 17 00:00:00 2001
From: Vitalii Kiiko <mr.psiho@gmail.com>
Date: Wed, 16 Apr 2025 10:33:19 +0200
Subject: [PATCH] - updated internal docs;

---
 src/store/index.js | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/src/store/index.js b/src/store/index.js
index 7633283..b2ccbde 100644
--- a/src/store/index.js
+++ b/src/store/index.js
@@ -1,4 +1,4 @@
-// stores
+// store API
 import { mainStore } from './main';
 import {
     useStoreValue as useStoreValueOriginal,
@@ -6,19 +6,19 @@ import {
     useTracked
 } from 'zustand-x';
 
-// migration: useStore -> useStoreValue
-// old: useStore().main.getRole() -- new: useStoreValue('getRole')
+// Hook. Subscribe to single store value with arguments
 export const useStoreValue = (key, ...args) => useStoreValueOriginal(mainStore, key, ...args);
 
+// Hook. Subscribe to the whole store (use ONLY if really needed (probably will not be needed though!))
 export const useStoreState = (key, ...args) => useStoreStateOriginal(mainStore, key, ...args);
 
-// migration: useTrackedStore -> useTrackedValue
+// Hook. Subscribe to single store value no arguments
 export const useTrackedValue = (key) => useTracked(mainStore, key);
 
-// old: storeGet.main.getRole() -- new: storeGet('getRole')
+// NOT hook. Get store value.
 export const storeGet = (key, ...args) => mainStore.get(key, ...args);
 
-// old: storeSet.main.removeElement(id) -- new: storeSet('removeElement', id)
+// NOT hook. Set store value
 export const storeSet = (key, ...args) => mainStore.set(key, ...args);
 
 export default mainStore;
\ No newline at end of file