readme

README.md

@@ -1,12 +1,59 @@
 # Correo
 
-Correo is a .NET service with the role of programmatically sending emails.
+Correo is a .NET service with the role of programmatically sending emails. Communication with this service is available through two channels simultaneously:
-It can integrate with:
+* HTTP (via REST API)
+* Pub/Sub Messaging (NATS)
 
-**SMTP servers:**
+It can be integrated with several types of mediators, the configuration being the following:
-* local servers
+
+```"SmtpMediator": "SendGrid" //.NET, MailKit, SendGrid```
+
+## Mediators
+
+### SMTP servers:
+* Local servers
 * Gmail
 * Yahoo
 
-**Transactional Email APIs:**
+The integration with SMTP servers can be done through two libraries (.NET / MailKit), and the configuration area looks like this:
-* SendGrid
+
+```
+"SmtpMediator": "MailKit",
+"SmtpClient": {
+  "Server": "smtp.gmail.com",
+  "Port": "587",
+  "UseAuthentication": true,
+  "Authentication": {
+    "UserName": "<account>@gmail.com",
+    "Domain": "",
+    "Password": "********"
+  },
+  "EnableSsl": true,
+  "TrustServer": false
+}
+```
+
+### Transactional Email APIs:
+#### SendGrid
+
+SendGrid is a cloud-based SMTP provider that allows you to send emails without having to maintain email servers. It has an excellent and easy-to-use email API with a free plan that allows you to send 100 emails per day.
+For this integration, the setup is very simple. All you need is an API Key generated from the [SendGrid](https://app.sendgrid.com/) platform. Afterwards, this API Key will be configured in Correo as below:
+
+```
+"SmtpMediator": "SendGrid"
+"SmtpService": {
+  "ApiKey": "xxxxxxxxxxx"
+}
+```
+
+## Database
+The database is SQLite. This is created automatically at the first start of the service if it is missing. The path where the database is stored can be configured as follows:
+
+```
+"Workspace": "workspace",
+"ConnectionStrings": {
+  "DatabaseConnection": "Data Source={Workspace}\\correo.db"
+}
+```
+
+For the moment, the only purpose of the database is to store the logs generated by Serilog.