From db39a682e2ce5552388fa4da5f8eb869b7da3df8 Mon Sep 17 00:00:00 2001 From: Alex Crichton Date: Mon, 9 Jan 2017 17:37:05 -0800 Subject: Clarify that serde is supported Closes #122 --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index d8520bb..97c35c3 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,37 @@ date with the TOML specification as changes happen. toml = "0.2" ``` +By default this crate supports [`rustc-serialize`] style serialization. This can +be disabled though by disabling the default feature set: + +[`rustc-serialize`]: http://github.com/rust-lang/rustc-serialize + +```toml +# Cargo.toml +[dependencies] +toml = { version = "0.2", default-features = false } +``` + +If you'd like to enable support for [serde] you can enable the `serde` feature: + +[serde]: https://github.com/serde-rs/serde + +```toml +# Cargo.toml +[dependencies] +toml = { version = "0.2", features = ["serde"] } +``` + +If you'd like to *only* support serde, you can also write: + +[serde]: https://github.com/serde-rs/serde + +```toml +# Cargo.toml +[dependencies] +toml = { version = "0.2", features = ["serde"], default-features = false } +``` + # License `toml-rs` is primarily distributed under the terms of both the MIT license and -- cgit v1.2.3