A full-featured CRM built with React, shadcn/ui, and Supabase.
Add README files for Admin and UI components
fzaninottoba8267e75ce7
diff --git a/src/components/admin/Readme.md b/src/components/admin/Readme.mdindex c1bb76c2..f2463996 100644--- a/src/components/admin/Readme.md+++ b/src/components/admin/Readme.md@@ -22,12 +22,14 @@ The components in this directory come from [Shadcn Admin Kit](https://marmelab.cThese 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.-## DocumentationYou can find the documentation for these components on the [Shadcn Admin Kit website](https://marmelab.com/shadcn-admin-kit/docs).+## Customization++In Atomic CRM, these components are sometimes slightly modified to fit the look and feel of the application. You can customize them further by editing the source files in this directory.+## UpdatesShadcn Admin Kit components are actively maintained and updated. To update the components in Atomic CRM, type the following command:diff --git a/src/components/ui/README.md b/src/components/ui/README.mdnew file mode 100644index 00000000..2dc90466--- /dev/null+++ b/src/components/ui/README.md@@ -0,0 +1,34 @@+# UI Components++The components in this directory come from [shadcn/ui](https://ui.shadcn.com/). They are low-level building blocks for creating user interfaces, including:++- Badges+- Buttons+- Cards+- Dialogs+- Forms Inputs+- Navigation MMenus+- Tables+- Tabs+- Tooltips+- And more...++These components are built on top of [Radix UI](https://www.radix-ui.com/) and styled using [Tailwind CSS](https://tailwindcss.com/).++## Documentation++You can find the documentation for these components on the [shadcn/ui website](https://ui.shadcn.com/docs).++## Customization++In Atomic CRM, these components are sometimes slightly modified to fit the look and feel of the application. You can customize them further by editing the source files in this directory.++## Updates++Shadcn/ui components are actively maintained and updated. To add or update a UI component in Atomic CRM, type the following command:++```+npx shadcn@latest add [component-name]+```++The admin components have a dependency on some ui components, so if you update the admin components, this will also update the ui components. Check [the admin components readme](../admin/Readme.md) for the command to update them.\ No newline at end of file