Browse Source

added usage details

Toastie 10 months ago
parent
commit
67d75d1666
1 changed files with 3 additions and 1 deletions
  1. 3 1
      README.md

+ 3 - 1
README.md

@@ -1,6 +1,6 @@
 # txt2mail
 ### Purpose
-Ship files, e.g. logs or status reports via e-mail.
+Ships plain text files, e.g. logs or status reports via e-mail.
 
 ### Functionality
 This image sends the content of each text file moved from the folder `1-prep` to `2-ready` via e-mail.
@@ -21,6 +21,8 @@ mail/
 ### Usage
 - `docker-compose up -d`
 - Bind-mount `txt2mail/data/mail`
+- Create a text file `1-prep` to be sent via mail
+- Move the file to `2-ready`
 
 ### Remarks
 - This container runs as uid/gid 1000