From e33bb22fde6db431a82bb9a67f5d6812b9306f50 Mon Sep 17 00:00:00 2001 From: PoiScript Date: Fri, 28 Jun 2019 14:29:45 +0800 Subject: [PATCH] docs: crate features --- README.md | 10 ++++++++++ src/lib.rs | 14 ++++++++++++++ 2 files changed, 24 insertions(+) diff --git a/README.md b/README.md index feb095d..b26a206 100644 --- a/README.md +++ b/README.md @@ -173,6 +173,16 @@ println!("{}", to_string(&org).unwrap()); // } ``` +## Features + +By now, orgize provides three features: + ++ `serde`: adds the ability to serialize `Org` and other elements using `serde`, enabled by default. + ++ `extra-serde-info`: includes the position information while serializing, disabled by default. + ++ `chrono`: adds the ability to convert `Datetime` into `chrono` struct, disabled by default. + ## License MIT diff --git a/src/lib.rs b/src/lib.rs index 993f675..1d71c09 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -215,6 +215,20 @@ //! // }] //! // } //! ``` +//! +//! # Features +//! +//! By now, orgize provides three features: +//! +//! + `serde`: adds the ability to serialize `Org` and other elements using `serde`, enabled by default. +//! +//! + `extra-serde-info`: includes the position information while serializing, disabled by default. +//! +//! + `chrono`: adds the ability to convert `Datetime` into `chrono` struct, disabled by default. +//! +//! # License +//! +//! MIT pub mod elements; pub mod export;