rust/lettre
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(all): Add complete documentation information to README

Browse Source
This commit is contained in:
Alexis Mousset
2016-10-19 22:13:21 +02:00
parent 67318ac759
commit eac29768ae
2 changed files with 25 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
Cargo.toml
View File

@@ -4,9 +4,8 @@ name = "lettre"
version = "0.6.0"
description = "Email client"
readme = "README.md"
documentation = "http://lettre.github.io/lettre/"
documentation = "https://lettre.github.io/lettre/"
repository = "https://github.com/lettre/lettre"
homepage = "http://lettre.github.io/"
license = "MIT"
authors = ["Alexis Mousset <contact@amousset.me>"]
keywords = ["email", "smtp", "mailer"]

28
README.md
View File

@@ -1,13 +1,33 @@
# lettre
[![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)
[![Coverage Status](https://coveralls.io/repos/lettre/lettre/badge.svg?branch=master&service=github)](https://coveralls.io/github/lettre/lettre?branch=master)
[![Coverage Status](https://coveralls.io/repos/github/lettre/lettre/badge.svg?branch=master)](https://coveralls.io/github/lettre/lettre?branch=master)
[![Crate](https://img.shields.io/crates/v/lettre.svg)](https://crates.io/crates/lettre)
[![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)
This is an email library written in Rust.
See the [documentation](http://lettre.github.io/lettre) for more information.
## Features
Lettre provides the following features:
* Multiple transport methods
* Unicode support (for email content and addresses)
* Secure delivery with SMTP using encryption and authentication
* Easy email builders
## Documentation
Released versions:
* [latest](https://lettre.github.io/lettre/)
* [v0.6.0](https://lettre.github.io/lettre/v0.6.0/lettre/)
* [v0.5.1](https://lettre.github.io/lettre/v0.5.1/lettre/)
Development version:
* [master](https://lettre.github.io/lettre/master/lettre/)
## Install
@@ -20,10 +40,10 @@ lettre = "0.6"
## Testing
The tests require a mail server listening locally on port 25.
The tests require an open mail server listening locally on port 25.
## License
This program is distributed under the terms of the MIT license.
See LICENSE for details.
See [LICENSE](./LICENSE) for details.