-```
- +--------------+
- +--------------+ | |
- | | | App plugin |
- | | | |
- | App | +--------------+
- | | +------+ GoVPP API |
- | | | +--------------+
- +--------------+ Go |
- | | channels | +--------------+
- | GoVPP core +------------+ | |
- | | | | App plugin |
- +------+-------+ | | |
- | | +--------------+
-binary API | +------+ GoVPP API |
- (shmem) | +--------------+
- |
- +------+-------+
- | |
- | VPP process |
- | |
- +--------------+
-```
+[![stable](https://img.shields.io/github/v/tag/fdio/govpp.svg?label=release&logo=github)](https://github.com/ligato/vpp-agent/releases/latest) [![PkgGoDev](https://pkg.go.dev/badge/go.fd.io/govpp)](https://pkg.go.dev/go.fd.io/govpp)
+
+The GoVPP repository contains a Go client library for interacting with the VPP,
+generator of Go bindings for the VPP binary API and various other tooling for VPP.
+
+## Overview
+
+Here is a brief overview for the repository structure.
+
+- [govpp](govpp.go) - the entry point for the GoVPP client
+ - [adapter](adapter) - VPP binary & stats API interface
+ - [mock](adapter/mock) - Mock adapter used for testing
+ - [socketclient](adapter/socketclient) - Go implementation of VPP API client for unix socket
+ - [statsclient](adapter/statsclient) - Go implementation of VPP Stats client for shared memory
+ - [vppapiclient](adapter/vppapiclient) - CGo wrapper of vppapiclient library (DEPRECATED!)
+ - [api](api) - GoVPP client API
+ - [binapigen](binapigen) - library for generating code from VPP API
+ - [vppapi](binapigen/vppapi) - VPP API parser
+ - cmd/
+ - [binapi-generator](cmd/binapi-generator) - VPP binary API generator
+ - [vpp-proxy](cmd/vpp-proxy) - VPP proxy for remote access
+ - [codec](codec) - handles encoding/decoding of generated messages into binary form
+ - [core](core) - implementation of the GoVPP client
+ - [docs](docs) - documentation
+ - [examples](examples) - examples demonstrating GoVPP functionality
+ - [internal](internal) - packages used internally by GoVPP
+ - [proxy](proxy) - contains client/server implementation for proxy
+ - [test](test) - integration tests, benchmarks and performance tests