Skip to content

Commit

Permalink
doc: update readme (#57)
Browse files Browse the repository at this point in the history
  • Loading branch information
alamenai authored Jun 11, 2024
1 parent eb529b1 commit 86e0116
Showing 1 changed file with 30 additions and 22 deletions.
52 changes: 30 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,37 @@
<div align='center'><img src="./src/assets/icon.png"/></div>

<p align="center">
<code align="center">Copy & Paste . Own your hook . Customize it later.</code>
</p>
<div align="center">
<code align="center">Copy & Paste . Own your hook . Customize it later.</code>
<a href="https://github.com/alamenai/rehook/stargazers"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/alamenai/rehook"></a>

<a href="https://twitter.com/magicuidesign"><img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/alamenai"></a>
<a href="https://github.com/magicuidesign/magicui/blob/main/LICENSE.md"><img alt="License" src="https://img.shields.io/badge/License-MIT-yellow.svg"></a>

</div>

<br/>
## Documentation

<div align="center">

[Get Started](https://www.rehook.dev/)
Visit https://rehook.dev to view the documentation.

</div>
## Contributing

Visit our [contributing guide](https://github.com/alamenai/rehook/blob/main/CONTRIBUTING.md) to learn how to contribute. It only takes ~5 minutes to add your own!

## Authors

<a href="https://github.com/magicuidesign/magicui/graphs/contributors">
<img src="https://contrib.rocks/image?repo=alamenai/rehook" />
</a>

## Deploy

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Falamenai%2Frehook)

## Stats

![Alt](https://repobeats.axiom.co/api/embed/411a9c5989586ca93ee4a27c871041e87872cfba.svg 'Repobeats analytics image')

## License

## Hooks

| Hook Name | Description |
| ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`useAbortController`](https://www.rehook.dev/hooks/use-abort-controller) | A custom hook for managing operations with an AbortController instance. This hook provides functionalities for aborting operations, checking if aborted, and managing abort conditions. |
| [`useBattery`](https://www.rehook.dev/hooks/use-battery) | A custom hook for fetching battery status information. |
| [`useFetch`](https://www.rehook.dev/hooks/use-fetch) | A custom hook for fetching data from an API. |
| [`useHistory`](https://www.rehook.dev/hooks/use-history) | A custom hook for managing browser history navigation. |
| [`useLoading`](https://www.rehook.dev/hooks/use-loading) | A custom hook that provides functionalities for managing loading state. |
| [`useLoading`](https://www.rehook.dev/hooks/use-loading) | A custom hook that provides functionalities for managing loading state. |
| [`useLocalStorage`](https://www.rehook.dev/hooks/use-local-storage) | A custom hook that provides functionalities for managing data in the browser's local storage. |
| [`usePersistentState`](https://www.rehook.dev/hooks/use-persistent-state) | A custom hook that provides persistent state management by storing state values in the browser's local storage. |
| [`useQueryParams`](https://www.rehook.dev/hooks/use-query-params) | A custom hook that provides functionalities for managing query parameters in the URL. |
| [`useTimeout`](https://www.rehook.dev/hooks/use-timeout) | A custom hook for managing timeouts. |
| [`useUrl`](https://www.rehook.dev/hooks/use-url) | A custom hook for accessing URL information. |
Licensed under the [MIT license](https://github.com/magicuidesign/magicui/blob/main/LICENSE.md).

0 comments on commit 86e0116

Please sign in to comment.