Update docs

codiume · Aug 18, 2024 · 9c82b62 · 9c82b62
1 parent 4fb2085
commit 9c82b62
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -22,12 +22,14 @@ npm install @codiume/hooks
 yarn add @codiume/hooks
 ```
 
-## Usage
-
-- [use-in-viewport](./docs/use-in-viewport)
-- [use-queue](./docs/use-queue)
-- [use-scroll](./docs/use-scroll)
-- [use-singleton](./docs/use-singleton)
+## Hooks
+
+| Hook          | Description |
+| ------------- | ----------- |
+| [use-in-viewport](./src/use-in-viewport) | Detects if element is visible in the viewport |
+| [use-queue](./src/use-queue)             | Manage state of elements in FIFO-like strategy |
+| [use-scroll](./src/use-scroll)           | Tracks scroll position of an element |
+| [use-singleton](./src/use-singleton)     | Creates a value exactly once |
 
 ## Contributing
 

diff --git a/docs/use-in-viewport/README.md → src/use-in-viewport/README.md b/docs/use-in-viewport/README.md → src/use-in-viewport/README.md
diff --git a/docs/use-queue/README.md → src/use-queue/README.md b/docs/use-queue/README.md → src/use-queue/README.md
@@ -1,6 +1,6 @@
 # 🔄 useQueue
 
-`useQueue` Provides a simple and efficient way to manage queue-like data structures in React applications,
+Provides a simple and efficient way to manage queue-like data structures in React applications,
 It's type-safe, easy to use, and can be adapted for various use cases where FIFO behavior is needed.
 
 ## Usage

diff --git a/docs/use-scroll/README.md → src/use-scroll/README.md b/docs/use-scroll/README.md → src/use-scroll/README.md
diff --git a/docs/use-singleton/README.md → src/use-singleton/README.md b/docs/use-singleton/README.md → src/use-singleton/README.md