From 34fc101f31455f035e857d66ad39681693732925 Mon Sep 17 00:00:00 2001
From: Alexis Mousset <alexis.mousset@normation.com>
Date: Sat, 14 Apr 2018 15:10:58 +0200
Subject: [PATCH] feat(all): Update README to put useful links at the top

---
 README.md                 | 39 +++++++++++++++++++++------------------
 website/content/README.md | 11 +++++++++++
 2 files changed, 32 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index d1d42de..7b8b5cb 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,26 @@
 # lettre
 
+**Lettre is a mailer library for Rust.**
+
 [![Build Status](https://travis-ci.org/lettre/lettre.svg?branch=master)](https://travis-ci.org/lettre/lettre)
 [![Build status](https://ci.appveyor.com/api/projects/status/mpwglemugjtkps2d/branch/master?svg=true)](https://ci.appveyor.com/project/amousset/lettre/branch/master)
+
 [![Crate](https://img.shields.io/crates/v/lettre.svg)](https://crates.io/crates/lettre)
 [![Docs](https://docs.rs/lettre/badge.svg)](https://docs.rs/lettre/)
+[![Required Rust version](https://img.shields.io/badge/rustc-1.18-green.svg)]()
 [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
+
 [![Gitter](https://badges.gitter.im/lettre/lettre.svg)](https://gitter.im/lettre/lettre?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 [![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/lettre/lettre.svg)](http://isitmaintained.com/project/lettre/lettre "Average time to resolve an issue")
 [![Percentage of issues still open](http://isitmaintained.com/badge/open/lettre/lettre.svg)](http://isitmaintained.com/project/lettre/lettre "Percentage of issues still open")
 
-An email library written in Rust.
+Useful links:
+
+* [User documentation](http://lettre.at/)
+* [API documentation](https://docs.rs/lettre/)
+* [Changelog](https://github.com/lettre/lettre/blob/master/CHANGELOG.md)
+
+---
 
 ## Features
 
@@ -22,6 +33,15 @@ Lettre provides the following features:
 
 ## Example
 
+This library requires Rust 1.18 or newer.
+To use this library, add the following to your `Cargo.toml`:
+
+```toml
+[dependencies]
+lettre = "0.8"
+lettre_email = "0.8"
+```
+
 ```rust,no_run
 extern crate lettre;
 extern crate lettre_email;
@@ -59,23 +79,6 @@ fn main() {
 }
 ```
 
-## Documentation
-
-* [User documentation](http://lettre.at/)
-* [API reference](https://docs.rs/lettre/)
-* [Changelog](https://github.com/lettre/lettre/blob/master/CHANGELOG.md)
-
-## Install
-
-This library requires rust 1.18 or newer.
-To use this library, add the following to your `Cargo.toml`:
-
-```toml
-[dependencies]
-lettre = "0.8"
-lettre_email = "0.8"
-```
-
 ## Testing
 
 The `lettre` tests require an open mail server listening locally on port 2525 and the `sendmail` command.
diff --git a/website/content/README.md b/website/content/README.md
index 58647a2..2fe905c 100644
--- a/website/content/README.md
+++ b/website/content/README.md
@@ -6,3 +6,14 @@ Lettre is an email library that allows creating and sending messages. It provide
 * Pluggable email transports
 * Unicode support (for emails and transports, including for sender et recipient addresses when compatible)
 * Secure defaults (emails are only sent encrypted by default)
+
+The `lettre_email` crate allows you to compose messages, and the `lettre`
+provide transports to send them.
+
+Lettre requires Rust 1.18 or newer. Add the following to your `Cargo.toml`:
+
+```toml
+[dependencies]
+lettre = "0.8"
+lettre_email = "0.8"
+```