From 6563e2f111c85fb13fe5143e5217cfe358b77a53 Mon Sep 17 00:00:00 2001 From: "Glenn Y. Rolland" Date: Wed, 22 Aug 2018 20:15:11 +0200 Subject: [PATCH] Add usage section to README --- README.md | 29 ++++++++++++++++++++++++++++- docker-compose.example.yml | 4 +++- 2 files changed, 31 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6f73b4e..2a10fbc 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,37 @@ Every morning, get the content of your favorite trello board by email ## Installation -Make sure you have Go installed, then type : +Make sure you have Go installed, then type: go install github.com/glenux/trello2mail-go/... +It will install Trello2Mail binary in `$GOPATH/bin` + + +## Usage + +Prepare your environment with the following variables + +``` +EMAIL_FROM: no-reply@example.com +EMAIL_TO: me@example.com +EMAIL_SUBJECT: "Daily mail for YYYYYY" +TRELLO_URL: https://trello.com/b/xxxxx/yyyy +TRELLO_TOKEN: xxxxxxxxxxxxxx +SMTP_HOSTNAME: smtp.example.com +SMTP_USERNAME: foobar@example.com +SMTP_PASSWORD: securefoobar +SMTP_PORT: 587 +# SMTP_AUTH_TYPE accepts either "none", "plain" or "login" +SMTP_AUTH_TYPE: plain +# SMTP_SECURITY_TYPE accepts either "none", "tls" or "starttls" +SMTP_SECURITY_TYPE: tls +``` + +Then run the program: + + $GOPATH/bin/trello2mail + ## Contributing diff --git a/docker-compose.example.yml b/docker-compose.example.yml index 04ad2e4..c938f21 100644 --- a/docker-compose.example.yml +++ b/docker-compose.example.yml @@ -12,6 +12,8 @@ services: SMTP_USERNAME: foobar@example.com SMTP_PASSWORD: securefoobar SMTP_PORT: 587 - SMTP_AUTH_TYPE: plain + # SMTP_AUTH_TYPE accepts either "none", "plain" or "login" + SMTP_AUTH_TYPE: plain + # SMTP_SECURITY_TYPE accepts either "none", "tls" or "starttls" SMTP_SECURITY_TYPE: tls