Add examples to readme

alexrudy · Mar 30, 2024 · 20d57dd · 20d57dd
1 parent 4484f62
commit 20d57dd
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -22,5 +22,7 @@ Disallow: /private
 Disallow: /tmp
 "#.parse::<Robots>().unwrap();
 
-assert_eq!(robots.allowed("/public"), true);
+let user_agent = "googlebot".parse().unwrap();
+
+assert_eq!(robots.is_allowed(&user_agent, "/public"), true);
 ```
diff --git a/src/lib.rs b/src/lib.rs
@@ -32,6 +32,11 @@ use crate::error::DirectivePathParseError;
 use crate::error::RobotParseError;
 use crate::error::UserAgentParseError;
 
+#[doc(hidden)]
+mod readme {
+    #![doc = include_str!("../README.md")]
+}
+
 const TSPECIALS: &str = "()<>@,;:\\\"/[]?={} \t";
 const PSAFE: &str = "$-_.+~";
 const PEXTRA: &str = "!*'(),";