Updating README with more information

This commit is contained in:
Matt McCoy 2016-06-15 19:55:55 -04:00
parent 148356273c
commit c90ab54ab0

View file

@ -3,11 +3,14 @@ rust-imap
IMAP Client for Rust IMAP Client for Rust
This client has SSL support. SSL is configured using an SSLContext that is passed into the connect method of a IMAPStream. If no SSL This client has SSL support. SSL is configured using an SSLContext that is passed into the connect method of a IMAPStream. If no SSL
support is wanted just pass in None. The library rust-openssl is used to support SSL for this project. support is wanted just pass in None. The library rust-openssl is used to support SSL for this project.
[![Build Status](https://travis-ci.org/mattnenterprise/rust-imap.svg)](https://travis-ci.org/mattnenterprise/rust-imap) [![Build Status](https://travis-ci.org/mattnenterprise/rust-imap.svg)](https://travis-ci.org/mattnenterprise/rust-imap)
[Documentation](http://mattnenterprise.github.io/rust-imap),
[crates.io](https://crates.io/crates/imap).
### Installation ### Installation
Add imap via your `Cargo.toml`: Add imap via your `Cargo.toml`:
@ -34,7 +37,7 @@ fn main() {
if let Err(e) = imap_socket.login("username", "password") { if let Err(e) = imap_socket.login("username", "password") {
println!("Error: {}", e) println!("Error: {}", e)
}; };
match imap_socket.capability() { match imap_socket.capability() {
Ok(capabilities) => { Ok(capabilities) => {
for capability in capabilities.iter() { for capability in capabilities.iter() {