docs: update docs

ciffelia · Apr 14, 2024 · aa97cfd · aa97cfd
1 parent c193474
commit aa97cfd
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -37,8 +37,12 @@ You can parse a string into a Nano ID using [`Nanoid::try_from_str`], [`std::str
 
 ```rust
 use nid::Nanoid;
+
+// From &str
 let id: Nanoid = Nanoid::try_from_str("K8N4Q7MNmeHJ-OHHoVDcz")?;
 let id: Nanoid = "3hYR3muA_xvjMrrrqFWxF".parse()?;
+
+// From String
 let id: Nanoid = "iH26rJ8CpRz-gfIh7TSRu".to_string().try_into()?;
 ```
 

diff --git a/src/lib.rs b/src/lib.rs
@@ -30,8 +30,12 @@
 //!
 //! ```
 //! use nid::Nanoid;
+//!
+//! // From &str
 //! let id: Nanoid = Nanoid::try_from_str("K8N4Q7MNmeHJ-OHHoVDcz")?;
 //! let id: Nanoid = "3hYR3muA_xvjMrrrqFWxF".parse()?;
+//!
+//! // From String
 //! let id: Nanoid = "iH26rJ8CpRz-gfIh7TSRu".to_string().try_into()?;
 //! # Ok::<(), Box<dyn std::error::Error>>(())
 //! ```