@muil/muil-javascript - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

@@ -34,3 +34,3 @@ {
   },
-  "version": "0.0.1"
+  "version": "0.0.2"
 }

README.md

@@ -17,2 +17,96 @@ # JavaScript development for Muil API
 
+## Initialization
+
+First you have to initialize the service with Api Key and project ID
+
+```
+import muil from '@muil/muil-javascript';
+
+muil.init({ apiKey: '123456.1234567890.awesomeProject', projectId: 'awesomeProject' });
+```
+
 ## Generate Template
+
+To generate html from template pass templateId and props
+
+```
+const html = await muil.generate({
+  templateId: 'awesomeTemplate',
+  props: { name: 'John' },
+});
+```
+
+You can also set type to 'pdf' or 'png' to generate PDF or png, functions returns pdf or png as binary string
+
+```
+const content = await muil.generate({
+  templateId: 'awesomeTemplate',
+  type: 'pdf',
+  props: { name: 'John' },
+});
+```
+
+## Send Email from Template
+
+To generate email from template and send it
+
+```
+muil.sendMail({
+  templateId: 'awesomeTemplate',
+  subject: 'This is an awesome mail',
+  to: '[e-mail]',
+  props: { name: 'John' },
+});
+```
+
+- from - The email address of the sender. All email addresses can be plain ‘[e-mail]’ or formatted '“Sender Name” [e-mail]’
+- to - Comma separated list or an array of recipients email addresses
+- cc - Comma separated list or an array of recipients email addresses
+- bcc - Comma separated list or an array of recipients email addresses
+- subject - The subject of the email
+  Y
+
+## Send Email from Template with Attchment
+
+```
+muil.sendMail({
+  templateId: 'awesomeTemplate',
+  subject: 'This is an awesome mail',
+  to: '[e-mail]',
+  props: { name: 'John' },
+  attachments: [{
+    filename: 'a.png',
+    type: 'png',
+    templateId: 'awesomeTemplate',
+    props: {
+      name: 'John',
+    }
+  },
+  {
+    filename: 'file.txt',
+    content: 'hello world!'
+  },
+  {
+    filename: 'license.txt',
+    path: 'https://example.com/license.txt'
+  }]
+});
+```
+
+## Upload Asset
+
+to upload asset to you Muil project bucket
+
+```
+await muil.uploadAsset('file.png', value);
+```
+
+Value can be a string, a buffer or a file stream.
+
+## Delete Asset
+
+to delete asset from Muil project bucket
+
+```
+await muil.deleteAsset('file.png');
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

14401

increased by16.23%

Number of lines in readme file

112

increased by522.22%

No dependency changes