vitess-gh/go/README.md

This directory contains all the Go code for Vitess.

Most of the packages at the top level are general-purpose and are suitable for use outside Vitess. Packages that are specific to Vitess are in the vt subdirectory. Binaries are in the cmd subdirectory.

Please see GoDoc for a listing of the packages and their purposes.

vt/proto contains the compiled protos for go, one per each directory. When importing these protos (for instance XXX.proto), we rename them on import to XXXpb. For instance:

import (
    topodatapb "github.com/youtube/vitess/go/vt/proto/topodata"
)