Added Windows requirements to README (#47)

* Added Windows requirements to README * add a heading --------- Co-authored-by: Maciej Wójcik <[email protected]>
DefGuard · Jan 23, 2024 · 54c5ede · 54c5ede
1 parent ee332fe
commit 54c5ede
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -9,9 +9,9 @@ It was developed as part of [defguard](https://github.com/defguard/defguard) sec
 
 ## Supported platforms
 
-* **Native OS Kernel**: Linux, FreeBSD (and pfSense/OPNSense) - Windows (in development)*
+* **Native OS Kernel**: Linux, FreeBSD (and pfSense/OPNSense), Windows
 * Userspace using [wireguard-go](https://github.com/WireGuard/wireguard-go) - Linux, **macOS**, FreeBSD
- 
+
 ### Unique features
 
 * **Peer routing** - see [WGApi](https://docs.rs/defguard_wireguard_rs/latest/defguard_wireguard_rs/struct.WGApi.html) docs.
@@ -20,6 +20,9 @@ It was developed as part of [defguard](https://github.com/defguard/defguard) sec
   * On Linux, handle network routing using **netlink**.
   * **fwmark** handling
 
+### Windows support
+Please note that [WireGuard](https://www.wireguard.com/install/) needs to be installed on Windows with commands `wg` and `wireguard` available to be called from the command line.
+
 ### Note on `wireguard-go`
 If you intend to use the userspace WireGuard implementation you should note that currently the library assumes 
 that the `wireguard-go` binary will be available at runtime. There are some sanity checks when instantiating the API,