add example to README

TheAlgorythm · Dec 4, 2023 · a1dacc6 · a1dacc6
1 parent 1018fb7
commit a1dacc6
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -5,3 +5,12 @@
 [![crev reviews](https://web.crev.dev/rust-reviews/badge/crev_count/path_ratchet.svg)](https://web.crev.dev/rust-reviews/crate/path_ratchet/)
 
 Prevent path traversal attacks at type level.
+
+```Rust
+use std::path::PathBuf;
+use path_ratchet::prelude::*;
+
+let user_input = "/etc/shadow";
+let mut filename = PathBuf::from("/tmp");
+filename.push_component(SinglePathComponent::new(user_input).unwrap());
+```
diff --git a/src/lib.rs b/src/lib.rs
@@ -24,6 +24,7 @@
 //! let mut filename = PathBuf::from("/tmp");
 //! filename.push_component(SinglePathComponent::new(user_input).unwrap());
 //! # }
+//! ```
 
 #[cfg(test)]
 mod tests;