feat: add README

Author: clement-lta

README.md

@@ -1,84 +1,32 @@
-# Turborepo starter
+<div align="center">
+<h1>tiny-react-hooks</h1>
+<div>A React hook library, written in Typescript.</div>
+<br />
+<div align="center">
+  <sub>Created by <a href="https://github.com/tuananhl">Tuan Anh</a>.</sub>
+</div>
 
-This Turborepo starter is maintained by the Turborepo core team.
+</div>
+<br />
 
-## Using this example
+## 💫 Introduction
 
-Run the following command:
+This is a React hooks library, written in Typescript and easy to use. It provides a set of hooks that enables you to build your React applications faster. There are hooks for most common use cases you might need.
 
-```sh
-npx create-turbo@latest
-```
-
-## What's inside?
-
-This Turborepo includes the following packages/apps:
-
-### Apps and Packages
-
-- `docs`: a [Next.js](https://nextjs.org/) app
-- `web`: another [Next.js](https://nextjs.org/) app
-- `@repo/ui`: a stub React component library shared by both `web` and `docs` applications
-- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
-- `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo
-
-Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
-
-### Utilities
-
-This Turborepo has some additional tools already setup for you:
-
-- [TypeScript](https://www.typescriptlang.org/) for static type checking
-- [ESLint](https://eslint.org/) for code linting
-- [Prettier](https://prettier.io) for code formatting
-
-### Build
-
-To build all apps and packages, run the following command:
-
-```
-cd my-turborepo
-pnpm build
-```
+### Usage example
 
-### Develop
+```tsx
+import { useDisclosure } from 'tiny-react-hooks' // might be deploy in the future
 
-To develop all apps and packages, run the following command:
+function Component() {
+  const { isOpen, onOpen, onClose, onToggle } = useDisclosure();
 
+  // ...
+}
 ```
-cd my-turborepo
-pnpm dev
-```
-
-### Remote Caching
-
-> [!TIP]
-> Vercel Remote Cache is free for all plans. Get started today at [vercel.com](https://vercel.com/signup?/signup?utm_source=remote-cache-sdk&utm_campaign=free_remote_cache).
-
-Turborepo can use a technique known as [Remote Caching](https://turbo.build/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
-
-By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup?utm_source=turborepo-examples), then enter the following commands:
-
-```
-cd my-turborepo
-npx turbo login
-```
-
-This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
-
-Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:
-
-```
-npx turbo link
-```
-
-## Useful Links
+## 🪝 Available Hooks
 
-Learn more about the power of Turborepo:
+<!-- HOOKS:START -->
 
-- [Tasks](https://turbo.build/docs/core-concepts/monorepos/running-tasks)
-- [Caching](https://turbo.build/docs/core-concepts/caching)
-- [Remote Caching](https://turbo.build/docs/core-concepts/remote-caching)
-- [Filtering](https://turbo.build/docs/core-concepts/monorepos/filtering)
-- [Configuration Options](https://turbo.build/docs/reference/configuration)
-- [CLI Usage](https://turbo.build/docs/reference/command-line-reference)
+- [`useDisclosure`] — handles boolean state with useful utility functions.
+<!-- HOOKS:END -->