Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aleclarson committed Jun 27, 2024
1 parent d7a05ad commit 0001c79
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,15 @@
Radashi, pronounced /raw-dash-ee/, is a modern, zero-dependency JavaScript utility toolkit built with TypeScript for type-safe, readable, and maintainable code. Radashi omits functions that have become obsolete in Lodash and introduces innovative tools for improved error handling, asynchronous operations, and data manipulation. With a focus on readability and maintainability, Radashi ensures that its source code is easy to understand and use, making it simple for developers to copy individual functions directly from GitHub if needed. Radashi is the go-to toolkit for cleaner, more efficient code in today's JavaScript ecosystem.

- **Is this related to Radash?**
Yes! This is a fork of the renowned [`radash`](https://github.com/sodiray/radash) library by Ray Epps [@sodiray](https://github.com/sodiray). This fork aims to be a more consistently maintained version of the library, with bug fixes and improvements.
Yes! This is a fork of the renowned [`radash`](https://github.com/sodiray/radash) library by Ray Epps [@sodiray](https://github.com/sodiray).

- **Why use this over Radash?**
This fork aims to be a more consistently maintained version, with bug fixes and improvements. We're open to adding many maintainers to the Radashi team, to keep responsiveness high.

We are a **community first** fork, which means putting the community's needs first. As such, your feedback is very welcome and we value your perspective. Specifically, we want you to [contribute your viewpoint](https://github.com/radashi-org/radashi/issues?q=is%3Aissue+is%3Aopen+label%3A%22feedback+wanted%22) to issues tagged “Feedback wanted”.

- **Is there official documentation?**
Currently, there is no documentation beyond this page. I will get to it eventually, but for now, you can refer to the original `radash` documentation.
Currently, there is no documentation beyond this page. There is work being done, which is tracked by #40. Until then, you can refer to the original `radash` documentation.

<a href="https://radash-docs.vercel.app">
<img src="https://github.com/radashi-org/radashi/raw/main/img/docs-button.png" alt="Radash documentation" width="250px" />
Expand Down

0 comments on commit 0001c79

Please sign in to comment.