chore: update docs

tauri-apps · Dec 28, 2022 · a9db8cf · a9db8cf
1 parent 38e89e9
commit a9db8cf
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/.changes/update-docs.md b/.changes/update-docs.md
@@ -0,0 +1,5 @@
+---
+"window-shadows": "patch"
+---
+
+Update docs to include conditional compliation flags.
diff --git a/README.md b/README.md
@@ -16,7 +16,8 @@ Add native shadows to your windows.
 ```rs
 use window_shadows::set_shadow;
 
-set_shadow(&window, true).expect("Unsupported platform!");
+#[cfg(any(windows, target_os = "macos"))]
+set_shadow(&window, true).unwrap();
 ```
 
 ## Screenshots

diff --git a/src/lib.rs b/src/lib.rs
@@ -16,7 +16,8 @@
 //! use window_shadows::set_shadow;
 //!
 //! # let window: &dyn raw_window_handle::HasRawWindowHandle = unsafe { std::mem::zeroed() };
-//! set_shadow(&window, true).expect("Unsupported platform!");
+//! #[cfg(any(windows, target_os = "macos"))]
+//! set_shadow(&window, true).unwrap();
 //! ```
 
 /// Enables or disables the shadows for a window.