diff --git a/packages/billing/README.md b/packages/billing/README.md new file mode 100644 index 000000000..30d3bc67d --- /dev/null +++ b/packages/billing/README.md @@ -0,0 +1,13 @@ +# Billing - @kit/billing +This package is responsible for managing billing and subscription related operations. + +Make sure the app installs the `@kit/billing` package before using it. + +```json +{ + "name": "my-app", + "dependencies": { + "@kit/billing": "*" + } +} +``` \ No newline at end of file diff --git a/packages/emails/README.md b/packages/emails/README.md new file mode 100644 index 000000000..9a713ef2a --- /dev/null +++ b/packages/emails/README.md @@ -0,0 +1,5 @@ +# Emails - @kit/emails + +This package is responsible for managing email templates using the react.email library. + +Here you can define email templates using React components and export them as a function that returns the email content. \ No newline at end of file diff --git a/packages/mailers/README.md b/packages/mailers/README.md new file mode 100644 index 000000000..aedc65aa7 --- /dev/null +++ b/packages/mailers/README.md @@ -0,0 +1,33 @@ +# Mailers - @kit/mailers + +This package is responsible for sending emails using a unified interface across the app. + +The default mailer uses the `nodemailer` package to send emails. You can create custom mailers by extending the `Mailer` class. + +Make sure the app installs the `@kit/mailers` package before using it. + +```json +{ + "name": "my-app", + "dependencies": { + "@kit/mailers": "*" + } +} +``` + +## Usage + +### Send an email + +```javascript +import { Mailer } from '@kit/mailers'; + +const mailer = new Mailer(); + +mailer.send({ + to: '', + from: '', + subject: 'Hello', + text: 'Hello, World!' +}); +``` \ No newline at end of file diff --git a/packages/supabase/README.md b/packages/supabase/README.md new file mode 100644 index 000000000..361642496 --- /dev/null +++ b/packages/supabase/README.md @@ -0,0 +1,14 @@ +# Supabase - @kit/supabase + +This package is responsible for managing the Supabase client and various utilities related to Supabase. + +Make sure the app installs the `@kit/supabase` package before using it. + +```json +{ + "name": "my-app", + "dependencies": { + "@kit/supabase": "*" + } +} +``` \ No newline at end of file diff --git a/packages/ui/README.md b/packages/ui/README.md new file mode 100644 index 000000000..9f77b8083 --- /dev/null +++ b/packages/ui/README.md @@ -0,0 +1,8 @@ +# UI - @kit/ui + +This package is responsible for managing the UI components and styles across the app. + +This package define two sets of components: + +- `shadn-ui`: A set of UI components that can be used across the app using shadn UI +- `makerkit`: Components specific to MakerKit \ No newline at end of file