Document the canonical import path in the README.

This commit is contained in:
David Anderson 2016-06-18 16:45:45 -07:00
parent f4ee0d5314
commit cbb14a347d

View File

@ -2,6 +2,16 @@
[![license](https://img.shields.io/github/license/google/netboot.svg?maxAge=2592000)](https://github.com/google/netboot/blob/master/LICENSE) [![Travis](https://img.shields.io/travis/google/netboot.svg?maxAge=2592000)](https://travis-ci.org/google/netboot) [![api](https://img.shields.io/badge/api-unstable-red.svg)](https://godoc.org/go.universe.tf/netboot) [![license](https://img.shields.io/github/license/google/netboot.svg?maxAge=2592000)](https://github.com/google/netboot/blob/master/LICENSE) [![Travis](https://img.shields.io/travis/google/netboot.svg?maxAge=2592000)](https://travis-ci.org/google/netboot) [![api](https://img.shields.io/badge/api-unstable-red.svg)](https://godoc.org/go.universe.tf/netboot)
The canonical import path for this repository is `go.universe.tf/netboot`:
```go
import (
"go.universe.tf/netboot/tftp"
"go.universe.tf/netboot/dhcp4"
"go.universe.tf/netboot/pcap"
)
```
This repository contains Go implementations of network protocols used This repository contains Go implementations of network protocols used
in booting machines over the network, as well as software that make in booting machines over the network, as well as software that make
use of those implementations. use of those implementations.