diff --git a/README.md b/README.md index c89be7d..ba46d9e 100644 --- a/README.md +++ b/README.md @@ -1,73 +1,3 @@ -
-

🛠 RDK

- Component ToolKit for React -
-
- - - - - - - - - - - - - - - - - - - - Open Collective backers and sponsors - -
+# RDK ---- - -RDK is a set of low-level tools that implement common interactions found in -component libraries. The tooling abstracts the visual -presentation so the tools can be used with any visual presentation. - -## 🚀 Quick Links -- Checkout the [demos and docs](https://reaviz.github.io/rdk/) -- Explore the library on [Chroma](https://www.chromatic.com/library?appId=5eb06076aebb8f00227a5659) - -## ✨ Features - -- Overlay - Provides a way to open floating panels on the screen -- Exit Listener - Provides a easy way to listen for exit events such as clicks and escape keypress. -- Portal - Provides a flexible system for rendering dynamic content into an application -- Position - Provides a flexible system for placing panels related to other elements -- Backdrop - Blocker element overlay -- Id - A unique ID hook -- User Select - A user select hook -- Cursor - A cursor hook - -## 📦 Install - -To use RDK in your project, install it via npm/yarn: - -``` -yarn add rdk -``` - -Visit the [demos page](https://reaviz.github.io/rdk/) to learn more! - -## 🔭 Development - -If you want to run RDK locally, its super easy! - -- Clone the repo -- `yarn install` -- `yarn start` -- Browser opens to Storybook page - -## ❤️ Contributors - -Thanks to all our contributors! - - +This package is deprecated and part of [https://reablocks.dev](https://reablocks.dev) now.