diff --git a/README.md b/README.md new file mode 100644 index 0000000..fd07ad8 --- /dev/null +++ b/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 = "" +port = "" # 25 or 587 +username = "" +password = "" + +[service] +outbox_path = "" # directory used to retrieve `.json` e-mail format to send +``` + +## Run +```bash +./mailsrv myconfig.ini +``` \ No newline at end of file