aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorOskari Timperi <oskari.timperi@iki.fi>2020-02-19 22:14:08 +0200
committerOskari Timperi <oskari.timperi@iki.fi>2020-02-19 22:14:08 +0200
commitb5665310e5c1e5d60893248ff146b1a60032dd87 (patch)
tree57e7eb9aea927f08c57879b452e82c3e6da4af14 /README.md
downloadifaddr-nim-b5665310e5c1e5d60893248ff146b1a60032dd87.tar.gz
ifaddr-nim-b5665310e5c1e5d60893248ff146b1a60032dd87.zip
initial commitHEADmaster
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
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
+```