From 9c82b624c46c7106bf6fe5d82147bf0f63b26cec Mon Sep 17 00:00:00 2001
From: Mohammed Elhaouari <m@codiume.com>
Date: Sun, 18 Aug 2024 20:04:56 +0100
Subject: [PATCH] Update docs

---
 README.md                               | 14 ++++++++------
 {docs => src}/use-in-viewport/README.md |  0
 {docs => src}/use-queue/README.md       |  2 +-
 {docs => src}/use-scroll/README.md      |  0
 {docs => src}/use-singleton/README.md   |  0
 5 files changed, 9 insertions(+), 7 deletions(-)
 rename {docs => src}/use-in-viewport/README.md (100%)
 rename {docs => src}/use-queue/README.md (95%)
 rename {docs => src}/use-scroll/README.md (100%)
 rename {docs => src}/use-singleton/README.md (100%)

diff --git a/README.md b/README.md
index 86efd33..f663637 100644
--- 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 b/src/use-in-viewport/README.md
similarity index 100%
rename from docs/use-in-viewport/README.md
rename to src/use-in-viewport/README.md
diff --git a/docs/use-queue/README.md b/src/use-queue/README.md
similarity index 95%
rename from docs/use-queue/README.md
rename to src/use-queue/README.md
index f6de6e1..e053d17 100644
--- a/docs/use-queue/README.md
+++ b/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 b/src/use-scroll/README.md
similarity index 100%
rename from docs/use-scroll/README.md
rename to src/use-scroll/README.md
diff --git a/docs/use-singleton/README.md b/src/use-singleton/README.md
similarity index 100%
rename from docs/use-singleton/README.md
rename to src/use-singleton/README.md