Skip to content

Commit

Permalink
Update introduction text with information about features and a quick …
Browse files Browse the repository at this point in the history
…link to a serde mapping guide
  • Loading branch information
Mingun authored and dralley committed Mar 12, 2023
1 parent 180f828 commit 1a967a6
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,13 @@
//! Especially for nested XML elements, the user must keep track _where_ (how deep)
//! in the XML document the current event is located.
//!
//! quick-xml contains optional support of asynchronous reading using [tokio].
//! quick-xml contains optional support of asynchronous reading and writing using [tokio].
//! To get it enable the `async-tokio` feature.
//!
//! Furthermore, quick-xml also contains optional [Serde] support to directly
//! serialize and deserialize from structs, without having to deal with the XML events.
//! To get it enable the `serialize` feature. Read more about mapping Rust types
//! to XML in the documentation of [`de`] module.
//!
//! # Examples
//!
Expand All @@ -33,6 +36,7 @@
//! [StAX]: https://en.wikipedia.org/wiki/StAX
//! [tokio]: https://tokio.rs/
//! [Serde]: https://serde.rs/
//! [`de`]: ./de/index.html
#![cfg_attr(
feature = "document-features",
cfg_attr(doc, doc = ::document_features::document_features!())
Expand Down

0 comments on commit 1a967a6

Please sign in to comment.