update doc

magiclen · Nov 29, 2023 · 3782825 · 3782825
1 parent 8d7847c
commit 3782825
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -33,6 +33,18 @@ use chinese_lunisolar_calendar::EarthlyBranch;
 assert_eq!(43, lunisolar_date.get_ba_zi_weight(EarthlyBranch::Ninth));
 ```
 
+To calculate the Ba Zi weight, the `ba-zi-weight` feature must be enabled.
+
+## No Std
+
+Disable the default features to compile this crate without std.
+
+```toml
+[dependencies.chinese-lunisolar-calendar]
+version = "*"
+default-features = false
+```
+
 ## Crates.io
 
 https://crates.io/crates/chinese-lunisolar-calendar

diff --git a/src/lib.rs b/src/lib.rs
@@ -33,6 +33,18 @@ use chinese_lunisolar_calendar::EarthlyBranch;
 assert_eq!(43, lunisolar_date.get_ba_zi_weight(EarthlyBranch::Ninth));
 # }
 ```
+
+To calculate the Ba Zi weight, the `ba-zi-weight` feature must be enabled.
+
+## No Std
+
+Disable the default features to compile this crate without std.
+
+```toml
+[dependencies.chinese-lunisolar-calendar]
+version = "*"
+default-features = false
+```
 */
 
 #![cfg_attr(not(feature = "std"), no_std)]