From cb372cd554d41e28307bc4ba28c388d1b423d1ef Mon Sep 17 00:00:00 2001 From: "Glenn Y. Rolland" Date: Wed, 4 Sep 2019 17:12:00 +0200 Subject: [PATCH] Fix technical documentation --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b07a010..f855991 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Compatibility: Make sure you have Go installed, then type: - go install github.com/glenux/musala-mail/... + $ go install github.com/glenux/musala-mail/... It will install Musala Mail binary in `$GOPATH/bin` @@ -21,25 +21,25 @@ It will install Musala Mail binary in `$GOPATH/bin` Make sure you have Docker installed, then type: - docker build -t musala-mail -f docker/Dockerfile . + $ docker build -t musala-mail -f docker/Dockerfile . ## Usage -## Creating a developper account +### Creating a developper account 1. Create a Trello account on 2. Check your mailbox and confirm your email 3. Enable developper account on 4. Get an developer API KEY -## Getting a Trello TOKEN +### Getting a Trello TOKEN Open the following URL in your web browser and authenticate yourself. That will give you the TRELLO_TOKEN that will be needed in the next step. -## Normal use +### Using the binary Prepare your environment with the following variables @@ -61,11 +61,12 @@ SMTP_SECURITY_TYPE: tls Then run the program: - $GOPATH/bin/musala-mail + $ $GOPATH/bin/musala-mail -### With docker +### Using with docker - docker run \ + $ docker build -f docker/Dockerfile -t musala-mail . + $ docker run \ -e EMAIL_FROM= -e EMAIL_TO= -e EMAIL_SUBJECT=