Skip to content

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

Add update instructions for Atomic CRM components

Francois Zaninotto3e254c4a6e6d
diff --git a/README.md b/README.md
index ce88d81d..7905e564 100644
--- a/README.md
+++ b/README.md
@@ -73,9 +73,17 @@ make test
You can add your own unit tests powered by Jest anywhere in the `src` directory. The test files should be named `*.test.tsx` or `*.test.ts`.
+## Getting Updates
+
+Atomic CRM components are published as a Shadcn Registry file. This means you can update your installation by calling the following command:
+
+```sh
+npx shadcn add https://marmelab.com/atomic-crm/r/atomic-crm.json -o
+```
+
## Registry
-Atomic CRM components are published as a Shadcn Registry file:
+The Registry file is kept au to date when files are added or removed:
- The `registry.json` file is automatically generated by the `scripts/generate-registry.mjs` script as a pre-commit hook.
- The `http://marmelab.com/atomic-crm/r/atomic-crm.json` file is automatically published by the CI/CD pipeline