add README.md

README.md

@@ -0,0 +1,26 @@
+# mailsrv
+A little service to send e-mail.
+
+## Build
+```bash
+make
+```
+`mailsrv` binary will be compiled.
+
+## Configuration
+`mailsrv` uses an SMTP server to send e-mail so, you need to provide some informations to send e-mails through it:
+```ini
+[server]
+url = "<smtp_url>"
+port = "<smtp_port>" # 25 or 587
+username = "<username>"
+password = "<password>"
+
+[service]
+outbox_path = "<dir_path>" # directory used to retrieve `.json` e-mail format to send
+```
+
+## Run
+```bash
+./mailsrv myconfig.ini
+```