Add documentation and generate readmes

1 files changed, 17 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0f381a9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# nftnl
+
+Safe abstraction for [`libnftnl`]. Provides low-level userspace access to the in-kernel
+nf_tables subsystem. See [`nftnl-sys`] for the low level FFI bindings to the C library.
+
+Can be used to create and remove tables, chains, sets and rules from the nftables firewall,
+the successor to iptables.
+
+## Selecting version of `libnftnl`
+
+See the documentation for the corresponding sys crate for details: [`nftnl-sys`]
+This crate has the same features as the sys crate, and selecting version works the same.
+
+[`libnftnl`]: https://netfilter.org/projects/libnftnl/
+[`nftnl-sys`]: https://crates.io/crates/nftnl-sys
+
+License: MIT/Apache-2.0