chore: update README and index documentation to clarify library funct…

…ionality and integration with React
Rajaniraiyn · Dec 25, 2024 · 06325a5 · 06325a5
1 parent 49ef6cd
commit 06325a5
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 ![npm](https://img.shields.io/npm/v/react-alien-signals)
 ![Build](https://img.shields.io/github/actions/workflow/status/rajaniraiyn/react-alien-signals/docs.yml?branch=main)
 
-React Alien Signals is a **TypeScript** library that provides Jotai-like state management APIs built on top of [Alien Signals](https://github.com/stackblitz/alien-signals). It offers a seamless integration with React, leveraging `useSyncExternalStore` to ensure concurrency-safe re-renders and prevent tearing in concurrent React applications.
+React Alien Signals is a **TypeScript** library that provides hooks built on top of [Alien Signals](https://github.com/stackblitz/alien-signals). It offers a seamless integration with React, ensuring concurrency-safe re-renders without tearing.
 
 ## Table of Contents
 

diff --git a/src/index.ts b/src/index.ts
@@ -1,8 +1,7 @@
 /**
  *
- * A complete TypeScript library providing react hooks on top of Alien Signals.
- * It covers basic signals, computed, effects, scopes, asynchronous signals, computed collections,
- * and exposes React hooks to seamlessly integrate with React using useSyncExternalStore.
+ * React Alien Signals is a **TypeScript** library that provides hooks built on top of [Alien Signals](https://github.com/stackblitz/alien-signals).
+ * It offers a seamless integration with React, ensuring concurrency-safe re-renders without tearing.
  *
  * @module react-alien-signals
  */