diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..5f0e32f --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# ifaddr - Enumerate IP addresses on the local network adapters + +This is a Nim port of a Python package of the same name. See the original [here](https://github.com/pydron/ifaddr). + +Check the example code in `tests/test1.nim`. It should output something like the following: + +``` +IPs of network adapter lo + 127.0.0.1/8 + 00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:01/128 +IPs of network adapter wlp2s0 + 192.168.0.101/24 + FE:80:00:00:00:00:00:00:65:93:59:F2:33:F0:AB:33/64 +``` |