Skip to content

Commit 50fdae5

Browse files
committed
README: Flesh out the intention and references, etc.
Signed-off-by: Ikey Doherty <ikey@thunderbird.net>
1 parent 6865d6c commit 50fdae5

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,24 @@
11
# Exchange Web Services
22

3-
This rust crate holds types that represent data structures and operations for
4-
the Exchange Web Services API, as well as the necessary infrastructure to
5-
serialize and deserialize them to/from XML.
3+
This repository contains the `ews-rs` Rust crate, home to a number of specialized
4+
data structures and scaffolding APIs to serialize and deserialize [EWS SOAP API](https://learn.microsoft.com/en-us/exchange/client-developer/web-service-reference/ews-reference-for-exchange)
5+
requests and responses in a more idiomatic fashion.
6+
7+
Client libraries can be built atop this crate, as we explicitly focus on the protocol
8+
format rather than applications specifics such as socket negotiation or stream management.
9+
10+
The reference implementation for this crate is the upcoming EWS protocol in [Thunderbird](https://thunderbird.net):
11+
12+
- `XPCOM` encapsulation: [ews_xpcom](https://hg.mozilla.org/comm-central/file/tip/rust/ews_xpcom)
13+
- C++ protocol bridging: [ews](https://hg.mozilla.org/comm-central/file/tip/mailnews/protocols/ews)
14+
15+
## Minimum Supported Rust Version
16+
17+
The `MSRV` for `ews-rs` is currently: `1.62.1`
18+
19+
Note that the use within `comm-central` may require a different MSRV than demonstrable by the code here.
20+
For further information please consult the [Rust Update Policy](https://firefox-source-docs.mozilla.org/writing-rust-code/update-policy.html#minimum-supported-rust-version)
21+
22+
## License
23+
24+
`ews-rs` is available under the terms of the [MPL-2.0](https://spdx.org/licenses/MPL-2.0.html) license.

0 commit comments

Comments
 (0)