update readme for windows users

README.md

@@ -197,9 +197,24 @@ Other plugins I find useful in my day-to-day zettelkasten work:
 
 Somewhere in your vim config, put a snippet like this:
 
+**Windows and macOS** users, please note: While this plugin works on Windows and macOS, it was not specifically designed
+to support Windows well. Even on macOS, some of the features like image preview will not work out-of-the-box.
+
+To avoid the most common Windows issue:
+
+- Best option: don't use Windows if possible
+- Second best option: try WSL2 on Windows and pretend you're on Linux
+- if you **must** use Windows, use `/Users/myname/zettelkasten` instead of `~/zettelkasten`
+- **NEVER** use `C:\Users\myname` style paths
+
 ```lua
 lua << END
 local home = vim.fn.expand("~/zettelkasten")
+-- NOTE for Windows users:
+-- - don't use Windows
+-- - try WSL2 on Windows and pretend you're on Linux
+-- - if you **must** use Windows, use "/Users/myname/zettelkasten" instead of "~/zettelkasten"
+-- - NEVER use "C:\Users\myname" style paths
 require('telekasten').setup({
     home         = home,
 
@@ -311,6 +326,11 @@ END
 | setting | description | example |
 | --- | --- | --- |
 | `home` | path to your zettelkasten folder (folder with markdown files) | ~/zettelkasten |
+|        | NOTE for Windows users: | |
+|        | - don't use Windows | |
+|        | - try WSL2 on Windows and pretend you're on Linux | |
+|        | - if you **must** use Windows, use `/Users/myname/zettelkasten` instead of `~/zettelkasten` | |
+|        | - **NEVER** use `C:\Users\myname` style paths | |
 | **`take_over_my_home`** | if set to `true` (default), telekasten will take over your home. Any notes from the configured `home` directory will receive a `set filetype=telekasten`, no matter if opened by telekasten or another way. | true |
 | `dailies` | path where your daily notes go | ~/zettelkasten/daily |
 | `weeklies` | path where your weekly notes go | ~/zettelkasten/weekly |