From f3c5d2ebca65f487e372ea3c04476b045ea14776 Mon Sep 17 00:00:00 2001
From: Alexis Mousset <contact@amousset.eu>
Date: Mon, 3 Nov 2014 12:01:25 +0100
Subject: [PATCH] Document the example program

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index 61cf7d2..a51d9db 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,20 @@ git = "https://github.com/amousset/rust-smtp.git"
 
 Otherwise, clone this repo and run `cargo build`.
 
+Example
+-------
+
+There is an example command-line program:
+```
+$ cargo test
+$ env RUST_LOG=info ./target/examples/client -r sender@localhost recipient@localhost < email.txt
+INFO:smtp::client: Connection established to localhost[127.0.0.1]:25
+INFO:smtp::client: from=<sender@localhost>, size=989, nrcpt=1
+INFO:smtp::client: to=<recipient@localhost>, status=sent (250 2.0.0 Ok: queued as 9D28F1C0A51)
+```
+
+Run `./target/examples/client -h` to get a list of options.
+
 Documentation
 -------------