From 545242b7db6aa63bac7ba5abcb48f81e2093c1f8 Mon Sep 17 00:00:00 2001 From: Anatoli Babenia Date: Mon, 13 Aug 2018 04:16:08 +0800 Subject: [PATCH] Update README.md Put `pixiecore` program first as it is what most users want --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index cbcce86..3236900 100644 --- a/README.md +++ b/README.md @@ -3,20 +3,21 @@ [![license](https://img.shields.io/github/license/google/netboot.svg)](https://github.com/google/netboot/blob/master/LICENSE) [![CircleCI](https://img.shields.io/circleci/project/github/google/netboot.svg)](https://circleci.com/gh/google/netboot) [![api](https://img.shields.io/badge/api-unstable-red.svg)](https://godoc.org/go.universe.tf/netboot) This repository contains Go implementations of network protocols used -in booting machines over the network, as well as software that make -use of those implementations. +in booting machines over the network, as well as utilites built on top +of these libraries. This is not an official Google project. -The canonical import path for Go packages in this repository is `go.universe.tf/netboot`. +## Programs + +- [Pixiecore](https://github.com/google/netboot/tree/master/pixiecore): Command line all-in-one tool for easy netbooting ## Libraries +The canonical import path for Go packages in this repository is `go.universe.tf/netboot`. + - [pcap](https://godoc.org/go.universe.tf/netboot/pcap): Pure Go implementation of reading and writing pcap files. - [dhcp4](https://godoc.org/go.universe.tf/netboot/dhcp4): DHCPv4 library providing the low-level bits of a DHCP client/server (packet marshaling, RFC-compliant packet transmission semantics). - [tftp](https://godoc.org/go.universe.tf/netboot/tftp): Read-only TFTP server implementation. -- [pixiecore](https://godoc.org/go.universe.tf/netboot/pixiecore): the functionality of Pixiecore (see below), in library form. Every stability warning in this repository applies double for this package. +- [pixiecore](https://godoc.org/go.universe.tf/netboot/pixiecore): Go library for Pixiecore tool functionality. Every stability warning in this repository applies double for this package. -## Programs - -- [Pixiecore](https://github.com/google/netboot/tree/master/pixiecore): an all-in-one tool for easy netbooting.