From 81b6210ce5e10bb57b3920cf88b9a3c5c7e1ce19 Mon Sep 17 00:00:00 2001 From: Juan Batiz-Benet Date: Sat, 11 Oct 2014 01:23:37 -0700 Subject: [PATCH] documentation --- README.md | 11 +++++++++++ doc.go | 5 +++++ 2 files changed, 16 insertions(+) create mode 100644 README.md create mode 100644 doc.go diff --git a/README.md b/README.md new file mode 100644 index 0000000..41f1cb3 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# multiaddr/net - Multiaddr friendly net + +Package multiaddr/net provides Multiaddr specific versions of common +functions in stdlib's net package. This means wrappers of +standard net symbols like net.Dial and net.Listen, as well +as conversion to/from net.Addr. + +Docs: + +- `multiaddr/net`: https://godoc.org/github.com/jbenet/go-multiaddr/net +- `multiaddr`: https://godoc.org/github.com/jbenet/go-multiaddr diff --git a/doc.go b/doc.go new file mode 100644 index 0000000..d73b865 --- /dev/null +++ b/doc.go @@ -0,0 +1,5 @@ +// Package net provides Multiaddr specific versions of common +// functions in stdlib's net package. This means wrappers of +// standard net symbols like net.Dial and net.Listen, as well +// as conversion to/from net.Addr. +package net