add README

This commit is contained in:
Michael Stapelberg 2018-06-08 17:15:29 +02:00
parent dab6002a09
commit 274a55e6d8
1 changed files with 16 additions and 0 deletions

16
README.md Normal file
View File

@ -0,0 +1,16 @@
This package manipulates Linux nftables (the iptables successor). It is
implemented in pure Go, i.e. does not wrap libnftnl.
This is not an official Google product.
## Breaking changes
This package is in very early stages, and only contains enough data types and
functions to install very basic nftables rules. It is likely that mistakes with
the data types/API will be identified as more functionality is added.
## Contributions
Contributions are very welcome!