maint: minor description changes

Cargo.toml

@@ -6,7 +6,7 @@ edition = "2021"
 exclude = ["/examples", "/node_modules"]
 links = "tauri-plugin-desktop-underlay"
 
-description = "Tauri plugin for making a window a desktop underlay, as if it were a wallpaper."
+description = "Tauri plugin for making a window a desktop underlay, attached to the desktop, above the wallpaper, and below desktop icons."
 keywords = ["tauri", "plugin", "desktop", "underlay", "wallpaper"]
 homepage = "https://github.com/Charlie-XIAO/tauri-plugin-desktop-underlay"
 repository = "https://github.com/Charlie-XIAO/tauri-plugin-desktop-underlay"

FAQ.md

@@ -0,0 +1,9 @@
+# FAQ
+
+This is a growing collection of FAQs.
+
+## The window cannot receive mouse/keyboard events when set as desktop underlay.
+
+This is the **expected behavior**: setting a window as a desktop underlay disables all types of user interactions with that window. It is indeed possible to use system APIs to listen to mouse and keyboard inputs and forward them to the window, but this is out of scope of this plugin.
+
+Alternatively, you may consider using Tauri's `always_on_bottom` and `ignore_cursor_events` features to make a window that always stays below other windows and that the mouse can click through.

README.md

@@ -1,6 +1,6 @@
 # PLUGIN-DESKTOP-UNDERLAY
 
-Tauri plugin to set a window as a desktop underlay. It is attached to the desktop, staying above the wallpaper but below desktop icons.
+Tauri plugin for making a window a desktop underlay, attached to the desktop, above the wallpaper, and below desktop icons.
 
 - **Linux:** ✅ (Untested)
 - **MacOS:** ✅ (Untested)
@@ -95,6 +95,10 @@ let _ = main_window.set_desktop_underlay(true);
 let _ = main_window.set_desktop_underlay(false);
 ```
 
+## FAQ
+
+See [FAQ](./FAQ.md).
+
 ## Contributing
 
 Issues and PRs are welcome. Since I am only using Windows for desktop development, it would be nice to get feedback from users on different platforms so that I can fix problems to the best of my abilities.

package.json

@@ -2,7 +2,7 @@
   "name": "tauri-plugin-desktop-underlay-api",
   "version": "0.0.1",
   "author": "Yao Xiao <[email protected]>",
-  "description": "Tauri plugin for making a window a desktop underlay, as if it were a wallpaper.",
+  "description": "Tauri plugin for making a window a desktop underlay, attached to the desktop, above the wallpaper, and below desktop icons.",
   "type": "module",
   "types": "./dist-js/index.d.ts",
   "main": "./dist-js/index.cjs",
@@ -13,8 +13,7 @@
     "require": "./dist-js/index.cjs"
   },
   "files": [
-    "dist-js",
-    "README.md"
+    "dist-js"
   ],
   "scripts": {
     "prepublishOnly": "pnpm build",