Skip to content
This repository has been archived by the owner on Jul 22, 2024. It is now read-only.

Commit

Permalink
Encourage using gopkg.in for a stable, versioned URL
Browse files Browse the repository at this point in the history
  • Loading branch information
ecbaldwin committed Oct 29, 2018
1 parent ef271be commit 9244c4c
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
Library to complement the [go net library][net] and provide containers and
utilities like in python's [netaddr].
# go netaddr package

Please see the [api documentation] for details.
This repo contains a library to complement the [go net library][net] and
provide containers and utilities like in python's [netaddr].

[api documentation]: https://godoc.org/github.com/IBM/netaddr
Please see the [api documentation] for details. [The authoritative source for
this library is found on github][source]. We encourage importing this code
using the stable, versioned URL provided by [gopkg.in][gopkg]. Once imported,
refer to it as `netaddr` in your code (without the version).

import "gopkg.in/netaddr.v1"

## help

This needs a lot of work. Help if you can!

Expand All @@ -12,3 +19,6 @@ This needs a lot of work. Help if you can!

[netaddr]: https://netaddr.readthedocs.io/en/latest/installation.html
[net]: https://golang.org/pkg/net/
[api documentation]: https://godoc.org/gopkg.in/netaddr.v1
[source]: https://github.com/IBM/netaddr/
[gopkg]: https://gopkg.in/netaddr.v1

0 comments on commit 9244c4c

Please sign in to comment.