Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs + MSRV #6

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @babolivier @leftmostcat @ikeycode
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: Should we ask for a team to be created on the @thunderbird org (e.g. @rust-codeowners), so we don't need to modify this file when this list needs changing, and so we can share it between repos (e.g. xml-struct-rs)? Or would you prefer each repo has its own independent list of code owners?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes

25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
# Exchange Web Services

This rust crate holds types that represent data structures and operations for
the Exchange Web Services API, as well as the necessary infrastructure to
serialize and deserialize them to/from XML.
`ews` is a crate providing data structures and APIs for working with Microsoft's
[Exchange Web Services API](https://learn.microsoft.com/en-us/exchange/client-developer/web-service-reference/ews-reference-for-exchange).

## Status
At present, the focus of this crate is providing Rust equivalents of the data
structures specified in the EWS reference and API for serializing to and
deserializing from XML.
No client is provided for handling HTTP requests or responses, and as such,
this crate does not provide handling of authentication, server-side throttling,
or other error conditions. Additionally, it does not include an implementation
of the Autodiscover protocol or any other means of discovering EWS endpoints.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This crate was built to support the work-in-progress EWS protocol for
This crate was built to support the work-in-progress EWS protocol implementation for

nitpick: Since we're not working on the protocol spec.

This crate was built to support the work-in-progress EWS protocol for
[Thunderbird](https://thunderbird.net). If you have an interest in using this
crate and it is missing functionality you need or have ideas for improved
ergonomics, please get in touch with us.

## Minimum Supported Rust Version
The MSRV for `ews` is currently 1.62.1.

## License
`ews` is available under the terms of the Mozilla Public License, version 2.0.
See either our [LICENSE] file or [https://www.mozilla.org/en-US/MPL/2.0/].
5 changes: 5 additions & 0 deletions clippy.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.

msrv = "1.62.1"
Loading