Add README.md files for multiple @kit packages

Added README.md files for several @kit packages including Supabase, UI, Emails, Billing, and Mailers. These documents explain the purpose and usage of each package, facilitating better understanding for developers interacting with them.
This commit is contained in:
giancarlo
2024-03-24 02:50:55 +08:00
parent bce3479368
commit 06156e980d
5 changed files with 73 additions and 0 deletions

View File

@@ -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": "*"
}
}
```

View File

@@ -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.

View File

@@ -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!'
});
```

View File

@@ -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": "*"
}
}
```

8
packages/ui/README.md Normal file
View File

@@ -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