glenux/musala
glenux/musala
1
0
Fork 0
Code Issues 7 Pull requests Projects 1 Releases Wiki Activity

Add usage section to README

Browse source
This commit is contained in:
Glenn Y. Rolland 2018-08-22 20:15:11 +02:00
parent 703f7fe43e
commit 6563e2f111
2 changed files with 31 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -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

4
docker-compose.example.yml
View file

@ -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