commit 702a133287a19ec671b60f636a3c14848ea0095b
parent 85bb5f8915343c8bb5d97fa4de074db4ad65888c
Author: Drew DeVault <sir@cmpwn.com>
Date: Sun, 20 Jun 2021 10:39:20 -0400
net: add README
Signed-off-by: Drew DeVault <sir@cmpwn.com>
Diffstat:
1 file changed, 6 insertions(+), 0 deletions(-)
diff --git a/net/README b/net/README
@@ -0,0 +1,6 @@
+The net package provides some general-purpose interfaces and support code, but
+generally users are directed to the subpackages, where implementations of
+various network protocols are provided, such as [[net::tcp]] or [[net::dns]].
+
+A porcelain API for establishing an outgoing connection, able to automatically
+handle matters such as DNS resolution, is available at [[net::dial]].