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