Commit
+7 -5 +/-3 browse
| 1 | diff --git a/README.md b/README.md |
| 2 | index 86fa8f1..96fdb72 100644 |
| 3 | --- a/README.md |
| 4 | +++ b/README.md |
| 5 | @@ -25,8 +25,8 @@ within. |
| 6 | |
| 7 | ## Alpha Status |
| 8 | |
| 9 | - NOTE: This library is at best in an "alpha" state currently and should be used |
| 10 | - for _absolutely nothing_ that is important. |
| 11 | + This library is in an "alpha" state currently and should not be considered |
| 12 | + stable until it reaches version `1.0`, use at your own risk! |
| 13 | |
| 14 | ## Protocol Status |
| 15 | |
| 16 | diff --git a/maitred/src/lib.rs b/maitred/src/lib.rs |
| 17 | index b28dd50..0510814 100644 |
| 18 | --- a/maitred/src/lib.rs |
| 19 | +++ b/maitred/src/lib.rs |
| 20 | @@ -1,5 +1,7 @@ |
| 21 | //! Maitred is a flexible and embedable SMTP server for handling e-mail from |
| 22 | - //! within a Rust program. |
| 23 | + //! within a Rust program. Designed for use in [ayllu](https://ayllu-forge.org) |
| 24 | + //! but also for general use. |
| 25 | + //! |
| 26 | //! # Example SMTP Server |
| 27 | //! ```rust |
| 28 | //! use maitred::auth::PlainAuthFunc; |
| 29 | diff --git a/maitred/src/server.rs b/maitred/src/server.rs |
| 30 | index d036169..b1acee3 100644 |
| 31 | --- a/maitred/src/server.rs |
| 32 | +++ b/maitred/src/server.rs |
| 33 | @@ -192,8 +192,8 @@ impl Server { |
| 34 | self |
| 35 | } |
| 36 | |
| 37 | - /// Enable support for HAProxy's Proxy Protocol |
| 38 | - /// https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt |
| 39 | + /// Enable support for HAProxy's |
| 40 | + /// [Proxy Protocol](https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt) |
| 41 | pub fn proxy_protocol(mut self, enabled: bool) -> Self { |
| 42 | self.proxy_protocol = enabled; |
| 43 | self |