Skip to content

Commit

Permalink
docs: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
amrbashir committed Oct 31, 2021
1 parent 3700a78 commit 5d77b46
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 2 deletions.
5 changes: 5 additions & 0 deletions .changes/rust-edition-2021.md
@@ -0,0 +1,5 @@
---
"win7-notifications": patch
---

Migrate to rust edition 2021.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -6,7 +6,7 @@
Send Windows 10 styled notifications on Windows 7.

#### Note:
This crate requires a win32 event loop to be running, otherwise the notification will close immediately, check [examples/single.rs](examples/single.rs) which uses [tao](https://github.com/tauri-apps/tao) or you can use [winit](https://github.com/rust-windowing/winit) or just roll your own win32 event loop.
This crate requires a win32 event loop to be running on the thread, otherwise the notification will close immediately, check [examples/single.rs](examples/single.rs) which uses [tao](https://github.com/tauri-apps/tao) or you can use [winit](https://github.com/rust-windowing/winit) or just roll your own win32 event loop.


### TODO:
Expand Down
6 changes: 6 additions & 0 deletions src/lib.rs
Expand Up @@ -4,6 +4,12 @@

//! Send Windows 10 styled notifications on Windows 7.
//!
//! # Note:
//!
//! This crate requires a win32 event loop to be running on the thread, otherwise the notification will close immediately,
//! it is recommended to use it with other win32 event loop crates like [tao](https://docs.rs/tao) or
//! [winit](https://docs.rs/winit) or just roll your own win32 event loop.
//!
//! # Examples
//!
//! # Example 1: Simple Notification
Expand Down
2 changes: 1 addition & 1 deletion src/notification.rs
Expand Up @@ -114,7 +114,7 @@ impl Notification {

/// Shows the Notification.
///
/// Requires an win32 event_loop to be running, otherwise the notification will close immediately.
/// Requires an win32 event_loop to be running on the thread, otherwise the notification will close immediately.
pub fn show(&self) -> Result<()> {
unsafe {
let hinstance = LibraryLoader::GetModuleHandleW(w32f::PWSTR::default());
Expand Down

0 comments on commit 5d77b46

Please sign in to comment.