docs: add screen notifier doc

Ark2000 · Nov 17, 2023 · df61207 · df61207
1 parent 3faed08
commit df61207
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -64,6 +64,7 @@ For more detailed information, please read the following:
 - [Texture Viewer](./docs/texture_viewer.md)
 - [Misc Commands](./docs/misc_commands.md)
 - [General Settings](./docs/general_settings.md)
+- [Screen Notifier](./docs/screen_notifier.md)
 
 # Installation 🚀
 

diff --git a/docs/assets/screen_notifier_demo.mp4 b/docs/assets/screen_notifier_demo.mp4
diff --git a/docs/screen_notifier.md b/docs/screen_notifier.md
@@ -0,0 +1,13 @@
+# Screen Notifier
+
+Here's a short video demonstrating its functionalities.
+
+![screen notifier demo](./assets/screen_notifier_demo.mp4)
+
+You can use screen notifier to send one-off popup style notifications or durable resident notifications, simple yet powerful.
+
+The function `notify(any, id = -1)` is defined in the `Panku` singleton and implemented by `screen_notifier` module.
+
+## Related Files
+
+`panku_console/modules/texture_viewer/*`