Skip to content

Commit

Permalink
Add information regarding supported platforms to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
georg-jung committed Dec 13, 2019
1 parent c68bd4c commit 7ad1552
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,17 @@ Per default, the library waits for ping responses for up to 750ms on linux platf
Arp.LinuxPingTimeout = TimeSpan.FromMilliseconds(125);
```

## Supported platforms

* Windows (tested)
* Linux
* Debian (tested)
* Android
* **not** WSL 1 (tested)
* [WSL 2](https://github.com/Microsoft/WSL/issues/2279)

Note that the used method does not work in WSL 1 and might not work on every linux distribution. Checking the `Arp.IsSupported` property accounts for this (though it does not check if you are actually allowed to access `/proc/net/arp`). In WSL 2 this library will work as on most "real" linux distributions as [this issue describes](https://github.com/Microsoft/WSL/issues/2279). While I did not test this library on Android/Xamarin I have read in different places that reading `/proc/net/arp` is possible (given the right permissions).

## Credits

The windows version is based on [nikeee/wake-on-lan](https://github.com/nikeee/wake-on-lan).

0 comments on commit 7ad1552

Please sign in to comment.