summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthew Heon <matthew.heon@pm.me>2022-01-27 13:59:01 -0500
committerMatthew Heon <matthew.heon@pm.me>2022-01-27 13:59:01 -0500
commit3d646faa49ea80223413c281ea1e757377974db1 (patch)
treedc74ce46cdbf4390b7bf781b94662e69bfbd8ee7
parent8a61c9a23f1e0df440a04ff54cc37e527de0f32b (diff)
Bump to v1.0.0-rc1v1.0.0-rc1
Signed-off-by: Matthew Heon <matthew.heon@pm.me>
-rw-r--r--Cargo.toml2
-rw-r--r--README.md15
-rw-r--r--RELEASE_NOTES.md4
3 files changed, 13 insertions, 8 deletions
diff --git a/Cargo.toml b/Cargo.toml
index 06ee74c..1817e53 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "netavark"
-version = "0.0.1"
+version = "1.0.0-rc1"
edition = "2018"
authors = ["github.com/containers"]
description = "A container network stack"
diff --git a/README.md b/README.md
index f359ac5..1704927 100644
--- a/README.md
+++ b/README.md
@@ -6,13 +6,14 @@ for other OCI container management applications.
## Overview and scope
-Netavark is capable of the following given the proper JSON input:
-* Create, manage, and destroy network interfaces including bridge and macvlan
-* Configure firewall (NAT) and port mapping rules
-* Support IPv4 and IPv6
-
-As this project is in very early development, we will add more capabilities in
-the near future.
+Netavark is a tool for configuring networking for Linux containers. Its features include:
+* Configuration of container networks via JSON configuration file
+* Creation and management of required network interfaces, including MACVLAN networks
+* All required firewall configuration to perform NAT and port forwarding as required for containers
+* Support for iptables and firewalld at present, with support for nftables planned in a future release
+* Support for rootless containers
+* Support for IPv4 and IPv6
+* Support for container DNS resolution via the [aardvark-dns](https://github.com/containers/aardvark-dns) project
## Requires
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
new file mode 100644
index 0000000..18d778f
--- /dev/null
+++ b/RELEASE_NOTES.md
@@ -0,0 +1,4 @@
+# Release Notes
+
+## v1.0.0-RC1
+* This is the first release candidate of Netavark. All functionality should be working. \ No newline at end of file