refactor: remove unnecessary features, update docs

packages/react-charm/src/index.d.ts

@@ -1,29 +1,31 @@
 import { Binding } from "@rbxts/react";
 
 /**
- * A hook that subscribes to changes in the given atom or selector. The
- * component is re-rendered with the new state after an update.
+ * Returns a React state that updates when the getter function updates.
+ * Re-renders the component when the value changes.
  *
  * If the `dependencies` array is provided, a new effect is created for the
- * current `callback` when the dependencies change. Otherwise, the effect is
+ * current `getter` when the dependencies change. Otherwise, the effect is
  * created only once, when the component is mounted.
  *
- * @param callback The atom or selector to watch.
- * @param dependencies An array of values used to memoize the callback.
- * @returns The current state.
+ * @param getter The signal or selector to watch.
+ * @param dependencies An array of values used to memoize the getter.
+ * @return The current state.
  */
-export function useAtom<T>(callback: () => T, dependencies?: any[]): T;
+export function useSignalState<T>(getter: () => T, dependencies?: any[]): T;
 
 /**
- * A hook that subscribes to changes in the given atom or selector. Returns
- * a binding that updates when the state changes.
+ * Returns a React binding that updates when the getter function updates.
  *
  * If the `dependencies` array is provided, a new effect is created for the
- * current `callback` when the dependencies change. Otherwise, the effect is
+ * current `getter` when the dependencies change. Otherwise, the effect is
  * created only once, when the component is mounted.
  *
- * @param callback The atom or selector to watch.
- * @param dependencies An array of values used to memoize the callback.
- * @returns A binding that stores the current state.
+ * @param getter The atom or selector to watch.
+ * @param dependencies An array of values used to memoize the getter.
+ * @return A binding that stores the current state.
  */
-export function useAtomBinding<T>(callback: () => T, dependencies?: any[]): Binding<T>;
+export function useSignalBinding<T>(getter: () => T, dependencies?: any[]): Binding<T>;
+
+// Aliases
+export { useSignalState as useAtom };