Clean up README and only integrate README docs when std feature is set

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "typed-path"
 description = "Provides typed variants of Path and PathBuf for Unix and Windows"
-version = "0.6.0"
+version = "0.7.0"
 edition = "2021"
 authors = ["Chip Senkbeil <[email protected]>"]
 categories = ["development-tools", "filesystem", "os"]
@@ -11,13 +11,11 @@ repository = "https://github.com/chipsenkbeil/typed-path"
 readme = "README.md"
 license = "MIT OR Apache-2.0"
 
-[[example]]
-name = "windows_utf8"
-required-features = ["std"]
+[dependencies]
 
-[[example]]
-name = "unix"
-required-features = ["std"]
+[features]
+default = ["std"]
+std = []
 
 [[example]]
 name = "typed"
@@ -27,6 +25,10 @@ required-features = ["std"]
 name = "typed_utf8"
 required-features = ["std"]
 
+[[example]]
+name = "unix"
+required-features = ["std"]
+
 [[example]]
 name = "unix_utf8"
 required-features = ["std"]
@@ -35,8 +37,6 @@ required-features = ["std"]
 name = "windows"
 required-features = ["std"]
 
-[dependencies]
-
-[features]
-default = ["std"]
-std = []
+[[example]]
+name = "windows_utf8"
+required-features = ["std"]

README.md

@@ -191,23 +191,20 @@ form by prepending the current working directory if the path is relative and
 then normalizing it (requires `std` feature):
 
 ```rust
-# fn main() {
-# // absolutize is only supported with standard library
-# #[cfg(feature = "std")]
-# {
 use typed_path::{utils, Utf8UnixPath};
 
 // With an absolute path, it is just normalized
+// NOTE: This requires `std` feature, otherwise `absolutize` is missing!
 let path = Utf8UnixPath::new("/a/b/../c/./d");
 assert_eq!(path.absolutize().unwrap(), Utf8UnixPath::new("/a/c/d"));
 
 // With a relative path, it is first joined with the current working directory
 // and then normalized
+// NOTE: This requires `std` feature, otherwise `utf8_current_dir` and
+//       `absolutize` are missing!
 let cwd = utils::utf8_current_dir().unwrap().with_unix_encoding();
 let path = cwd.join(Utf8UnixPath::new("a/b/../c/./d"));
 assert_eq!(path.absolutize().unwrap(), cwd.join(Utf8UnixPath::new("a/c/d")));
-# }
-# }
 ```
 
 ### Current directory
@@ -217,23 +214,21 @@ feature), and one of those provides an identical experience to
 [`std::env::current_dir`](https://doc.rust-lang.org/std/env/fn.current_dir.html):
 
 ```rust
-# fn main() {
-# // utils::current_dir is only supported with standard library
-# #[cfg(feature = "std")]
-# {
 // Retrieves the current directory as a NativePath:
 //
 // * For Unix family, this would be Path<UnixEncoding>
 // * For Windows family, this would be Path<WindowsEncoding>
+//
+// NOTE: This requires `std` feature, otherwise `current_dir` is missing!
 let _cwd = typed_path::utils::current_dir().unwrap();
 
 // Retrieves the current directory as a Utf8NativePath:
 //
 // * For Unix family, this would be Utf8Path<Utf8UnixEncoding>
 // * For Windows family, this would be Utf8Path<Utf8WindowsEncoding>
+//
+// NOTE: This requires `std` feature, otherwise `utf8_current_dir` is missing!
 let _utf8_cwd = typed_path::utils::utf8_current_dir().unwrap();
-# }
-# }
 ```
 
 ## License

src/lib.rs

@@ -1,4 +1,4 @@
-#![doc = include_str!("../README.md")]
+#![cfg_attr(feature = "std", doc = include_str!("../README.md"))]
 #![cfg_attr(not(feature = "std"), no_std)]
 
 #[doc = include_str!("../README.md")]