diff --git a/src/easy/mod.rs b/src/easy/mod.rs index 2a7bd731..ecc8e3cc 100644 --- a/src/easy/mod.rs +++ b/src/easy/mod.rs @@ -2,7 +2,12 @@ //! //! This library implements a [TOML] v0.5.0 compatible parser, //! primarily supporting the [`serde`] library for encoding/decoding -//! various types in Rust. +//! various types in Rust +//! +//! **NOTE:** Unlike the core `toml_edit` API, this is not format preserving but is a drop-in +//! replacement for [toml-rs](https://github.com/alexcrichton/toml-rs) for those needing both +//! `toml_edit` and `toml-rs` but want either consistency in behavior or to reduce their +//! dependencies. //! //! TOML itself is a simple, ergonomic, and readable configuration format: //! diff --git a/src/lib.rs b/src/lib.rs index 50cfedd0..52c8a6d0 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -10,6 +10,8 @@ //! //! It is primarily tailored to the needs of [cargo-edit](https://github.com/killercup/cargo-edit/). //! +//! If you also need the ease of a more traditional API, see the [`easy`] module. +//! //! # Example //! //! ```rust