Skip to content

Commit 1a967a6

Browse files
Mingundralley
authored andcommitted
Update introduction text with information about features and a quick link to a serde mapping guide
1 parent 180f828 commit 1a967a6

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/lib.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,13 @@
1616
//! Especially for nested XML elements, the user must keep track _where_ (how deep)
1717
//! in the XML document the current event is located.
1818
//!
19-
//! quick-xml contains optional support of asynchronous reading using [tokio].
19+
//! quick-xml contains optional support of asynchronous reading and writing using [tokio].
20+
//! To get it enable the `async-tokio` feature.
2021
//!
2122
//! Furthermore, quick-xml also contains optional [Serde] support to directly
2223
//! serialize and deserialize from structs, without having to deal with the XML events.
24+
//! To get it enable the `serialize` feature. Read more about mapping Rust types
25+
//! to XML in the documentation of [`de`] module.
2326
//!
2427
//! # Examples
2528
//!
@@ -33,6 +36,7 @@
3336
//! [StAX]: https://en.wikipedia.org/wiki/StAX
3437
//! [tokio]: https://tokio.rs/
3538
//! [Serde]: https://serde.rs/
39+
//! [`de`]: ./de/index.html
3640
#![cfg_attr(
3741
feature = "document-features",
3842
cfg_attr(doc, doc = ::document_features::document_features!())

0 commit comments

Comments
 (0)