README.md
1# netlink [![builds.sr.ht status](https://builds.sr.ht/~mdlayher/netlink.svg)](https://builds.sr.ht/~mdlayher/netlink?) [![GoDoc](https://godoc.org/github.com/mdlayher/netlink?status.svg)](https://godoc.org/github.com/mdlayher/netlink) [![Go Report Card](https://goreportcard.com/badge/github.com/mdlayher/netlink)](https://goreportcard.com/report/github.com/mdlayher/netlink)
2
3Package `netlink` provides low-level access to Linux netlink sockets.
4MIT Licensed.
5
6For more information about how netlink works, check out my blog series
7on [Linux, Netlink, and Go](https://mdlayher.com/blog/linux-netlink-and-go-part-1-netlink/).
8
9If you have any questions or you'd like some guidance, please join us on
10[Gophers Slack](https://invite.slack.golangbridge.org) in the `#networking`
11channel!
12
13## Stability
14
15See the [CHANGELOG](./CHANGELOG.md) file for a description of changes between
16releases.
17
18This package has a stable v1 API and any future breaking changes will prompt
19the release of a new major version. Features and bug fixes will continue to
20occur in the v1.x.x series.
21
22The general policy of this package is to only support the latest, stable version
23of Go. Compatibility shims may be added for prior versions of Go on an as-needed
24basis. If you would like to raise a concern, please [file an issue](https://github.com/mdlayher/netlink/issues/new).
25
26**If you depend on this package in your applications, please use Go modules.**
27
28## Design
29
30A [number of netlink packages](https://godoc.org/?q=netlink) are already
31available for Go, but I wasn't able to find one that aligned with what
32I wanted in a netlink package:
33
34- Straightforward, idiomatic API
35- Well tested
36- Well documented
37- Doesn't use package/global variables or state
38- Doesn't necessarily need root to work
39
40My goal for this package is to use it as a building block for the creation
41of other netlink family packages.
42
43## Ecosystem
44
45Over time, an ecosystem of Go packages has developed around package `netlink`.
46Many of these packages provide building blocks for further interactions with
47various netlink families, such as `NETLINK_GENERIC` or `NETLINK_ROUTE`.
48
49To have your package included in this diagram, please send a pull request!
50
51![netlink ecosystem](./netlink.svg)
52