From 44004e225f2bb77303c8dbe592066400a8bacc0c Mon Sep 17 00:00:00 2001 From: kmein Date: Sat, 23 Jul 2016 21:35:51 +0200 Subject: [PATCH] Add usage to readme --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index e1f4e9e..9516075 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,27 @@ # gmail-send Command line interface for sending Gmail emails + +## Prerequisites + +* [Python 3](https://python.org) + +## Usage + +``` +usage: gmail-send.py [-h] [-s SUBJECT] [-v] [--html] + gmail_user gmail_pwd recipient + +Send an email message via SMTP. Message body is read from stdin. + +positional arguments: + gmail_user sender's gmail username (without domain) + gmail_pwd sender's gmail password + recipient recipient's email address (with domain) + +optional arguments: + -h, --help show this help message and exit + -s SUBJECT, --subject SUBJECT + email subject + -v, --verbose output sent message + --html send email as HTML +```