From 31647f99d06717ec0cbb3aef55476ebcdbbe7b1a Mon Sep 17 00:00:00 2001
From: Ivan Tham <pickfire@riseup.net>
Date: Tue, 26 May 2020 14:11:29 +0800
Subject: [PATCH] Add doc for different `Cow` usage by architecture

---
 src/lib.rs | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index d26c2b2..fe66056 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -32,6 +32,15 @@
 //! assert_eq!(size_of::<beef::Cow<str>>(), 3 * WORD);
 //! assert_eq!(size_of::<beef::lean::Cow<str>>(), 2 * WORD);
 //! ```
+//!
+//! To use different version of `beef::Cow` depending on pointer size on different architecture.
+//!
+//! ```rust
+//! #[cfg(target_pointer_width = "64")]
+//! use beef::lean::Cow;
+//! #[cfg(not(target_pointer_width = "64")]
+//! use beef::Cow;
+//! ```
 #![cfg_attr(feature = "const_fn", feature(const_fn))]
 #![warn(missing_docs)]
 #![cfg_attr(not(test), no_std)]