summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPhilipp Korber <philippkorber@gmail.com>2019-02-14 21:19:06 +0100
committerPhilipp Korber <philippkorber@gmail.com>2019-02-14 21:19:06 +0100
commit203e0ab5299fe4ea44b4f68520a4500e42e950e5 (patch)
treeed205a7e2524a386f8ade6831c195dabb6259b7d
parent1839267c17ed4c4b01dbd4aa2e77bbe25479beb4 (diff)
doc(mail): use absolute github links for example
- Else example links won't work on some of the places the readme is displayed at. - But this means the link will always go to the current master branch not the uploaded code. - We could point it to a tag/branch but then changing it manually with every release is bothersome and error prone.
-rw-r--r--mail/README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/mail/README.md b/mail/README.md
index 4dd7ee5..c51e5ea 100644
--- a/mail/README.md
+++ b/mail/README.md
@@ -33,17 +33,17 @@ Functionality steming from following crates is re-exported:
## Examples
-### [`mail_by_hand`](./examples/mail_by_hand.rs)
+### [`mail_by_hand`](https://github.com/1aim/mail/tree/master/mail/examples/mail_by_hand.rs)
Creates and encodes a simple mail without using any fancy helpers, templates or
similar.
-### [`mail_from_template`](./examples/mail_from_template/main.rs)
+### [`mail_from_template`](https://github.com/1aim/mail/tree/master/mail/examples/mail_from_template/main.rs)
Uses the bindings for the `handlebars` template engine to create a mail, including
alternate bodies and an attachment.
-### [`send_mail`](./examples/send_mail/main.rs)
+### [`send_mail`](https://github.com/1aim/mail/tree/master/mail/examples/send_mail/main.rs)
A simple program which queries the user for information and then sends a
(simple) mail to an MSA (Mail Submission Agent). While it is currently limited