Skip to content

A full-featured CRM built with React, shadcn/ui, and Supabase.

Add Shadcn Admin Kit Readme

fzaninotto1ec368184ff5
diff --git a/src/components/admin/Readme.md b/src/components/admin/Readme.md
new file mode 100644
index 00000000..c1bb76c2
--- /dev/null
+++ b/src/components/admin/Readme.md
@@ -0,0 +1,38 @@
+# Admin Components
+
+The components in this directory come from [Shadcn Admin Kit](https://marmelab.com/shadcn-admin-kit/). They are application building blocks providing solution to usual single-page apps needs, including:
+
+- data fetching,
+- lists and data tables,
+- forms & validation,
+- authentication,
+- search & filtering,
+- i18n,
+- theming,
+- loading and error management.
+- rapid CRUD generation,
+- ralationship management,
+- roles & permissions,
+- optimistic UI,
+- undo functionality,
+- bulk actions,
+- user preferences,
+- notifications,
+- and more.
+
+These components are built on top of [TanStack Query](https://tanstack.com/query/latest), [React Hook Form](https://react-hook-form.com/), [React Router](https://reactrouter.com/), [ra-core](https://marmelab.com/ra-core/), [Radix UI](https://www.radix-ui.com/) and [Shadcn UI](https://ui.shadcn.com/).
+
+In Atomic CRM, these components are sometimes slightly modified to fit the look and feel of the application.
+
+## Documentation
+
+You can find the documentation for these components on the [Shadcn Admin Kit website](https://marmelab.com/shadcn-admin-kit/docs).
+
+## Updates
+
+Shadcn Admin Kit components are actively maintained and updated. To update the components in Atomic CRM, type the following command:
+
+```
+npx shadcn@latest add -o https://marmelab.com/shadcn-admin-kit/r/shadcn-admin-kit-base.json
+```
+