Add Doctest for README.md

Ensure testing of examples in the README.

Cargo.toml

@@ -27,6 +27,7 @@ serde = { optional = true, version = "1.0.110", features = ["derive"] }
 [dev-dependencies]
 proptest = "1.0.0"
 pretty_assertions = "1.0.0"
+doc-comment = "0.3"
 
 [dev-dependencies.cargo-husky]
 version = "1"

README.md

@@ -68,9 +68,9 @@ Another approach is to use a more readable *builder* which also allows you to ig
 in the ARN you don't always need and uses a more fluent style of ARN construction.
 
 ```rust
-45Muse aws_arn::builder::{ArnBuilder, ResourceBuilder};
+use aws_arn::builder::{ArnBuilder, ResourceBuilder};
 use aws_arn::known::{Partition, Service};
-use aws_arn::{ResourceName, Identifier};
+use aws_arn::{ResourceName, Identifier, IdentifierLike};
 use std::str::FromStr;
 
 let arn: ResourceName = ArnBuilder::service_id(Service::S3.into())

src/lib.rs

@@ -666,6 +666,13 @@ impl ResourceName {
     }
 }
 
+// ------------------------------------------------------------------------------------------------
+// External Doc Tests
+// ------------------------------------------------------------------------------------------------
+
+#[cfg(doctest)]
+doc_comment::doctest!("../README.md");
+
 // ------------------------------------------------------------------------------------------------
 // Modules
 // ------------------------------------------------------------------------------------------------
@@ -678,4 +685,4 @@ pub mod known;
 
 #[doc(hidden)]
 mod error;
-pub use crate::error::Error;
+pub use error::Error;