diff --git a/README.md b/README.md
index 37bfbe5eea..866c8615a7 100644
--- a/README.md
+++ b/README.md
@@ -2,135 +2,78 @@
-A declarative network manager API for hosts.
+A declarative network management API for hosts.
-[](https://coveralls.io/github/nmstate/nmstate?branch=base)
-[](https://badge.fury.io/py/nmstate)
+[
+[
[](https://src.fedoraproject.org/rpms/nmstate)
-[](https://github.com/python/black)
-[](https://lgtm.com/projects/g/nmstate/nmstate/context:python)
Copr build status, all repos are built for Fedora Linux and RHEL/CentOS Stream/EPEL 8+:
* Latest release: [](https://copr.fedorainfracloud.org/coprs/nmstate/nmstate/package/nmstate/)
* Git base: [](https://copr.fedorainfracloud.org/coprs/nmstate/nmstate-git/package/nmstate/)
-## What is it?
Nmstate is a library with an accompanying command line tool that manages
host networking settings in a declarative manner.
The networking state is described by a pre-defined schema.
-Reporting of the current state and changes to it (desired state) both conform to
+Reporting of current state and changes to it (desired state) both conform to
the schema.
Nmstate is aimed to satisfy enterprise needs to manage host networking through
-a northbound declarative API and multi-provider support on the southbound.
+a northbound declarative API and multi provider support on the southbound.
NetworkManager acts as the main (and currently the only) provider supported.
+Nmstate provides:
+ * Rust crate -- [nmstate][https://crates.io/crates/nmstate]
+ * Command line tools -- `cargo install nmstatectl`
+ * Python library -- `libnmstate`
+ * Go binding
+ * C binding
+
+More document could be found at [nmstate.io](https://nmstate.io)
+
## State example:
Desired/Current state example (YAML):
```yaml
-interfaces:
-- name: eth1
- type: ethernet
- state: up
- ipv4:
- enabled: true
- address:
- - ip: 192.0.2.10
- prefix-length: 24
- dhcp: false
- ipv6:
- enabled: true
- address:
- - ip: 2001:db8:1::a
- prefix-length: 64
- autoconf: false
- dhcp: false
-dns-resolver:
+---
+dns:
config:
- search:
- - example.com
- - example.org
server:
- - 2001:4860:4860::8888
- - 8.8.8.8
+ - 192.0.2.1
+ search:
+ - example.org
routes:
config:
- - destination: 0.0.0.0/0
- next-hop-address: 192.0.2.1
- next-hop-interface: eth1
- - destination: ::/0
- next-hop-address: 2001:db8:1::1
- next-hop-interface: eth1
-```
-
-## Basic Operations
-
-Show eth0 current state (python/shell):
-
-```python
-import libnmstate
-
-state = libnmstate.show()
-eth0_state = next(ifstate for ifstate in state['interfaces'] if ifstate['name'] == 'eth0')
-
-# Here is the MAC address
-eth0_mac = eth0_state['mac-address']
-```
-
-```shell
-nmstatectl show eth0
-```
-
-Change to the desired state (python/shell):
-
-```python
-import libnmstate
-
-# Specify a Linux bridge (created if it does not exist).
-state = {'interfaces': [{'name': 'br0', 'type': 'linux-bridge', 'state': 'up'}]}
-libnmstate.apply(state)
-```
-
-```shell
-# use YAML or JSON formats
-nmstatectl set desired-state.yml
-nmstatectl set desired-state.json
-```
-
-Edit the current state(python/shell):
-```python
-import libnmstate
-
-state = libnmstate.show()
-eth0_state = next(ifstate for ifstate in state['interfaces'] if ifstate['name'] == 'eth0')
-
-# take eth0 down
-eth0_state['state'] = 'down'
-libnmstate.apply(state)
-```
-
-```shell
-# open the current state in a text editor, change it and save to apply
-nmstatectl edit eth3
+ - destination: 0.0.0.0/0
+ next-hop-interface: eth1
+ next-hop-address: 192.0.2.1
+interfaces:
+ - name: eth1
+ type: ethernet
+ description: Main-NIC
+ state: up
+ ipv4:
+ enabled: true
+ dhcp: false
+ address:
+ - ip: 192.0.2.9
+ prefix-length: 24
+ ipv6:
+ enabled: false
```
## Contact
-*Nmstate* uses the [nmstate-devel@lists.fedorahosted.org][mailing_list] for
-discussions. To subscribe you can send an email with 'subscribe' in the subject
-to or visit the
-[mailing list page][mailing_list].
+*Nmstate* [GitHub Issues pages][github_issue_url] for discussion.
-There is also `#nmstate` on
-[Libera IRC](https://libera.chat/).
+You may find us in `#nmstate` on [Libera IRC](https://libera.chat/) also.
## Contributing
-Yay! We are happy to accept new contributors to the Nmstate project. Please follow
-these [instructions](CONTRIBUTING.md) to contribute.
+Yay! We are happy to accept new contributors to the Nmstate project. Please
+follow these [instructions](CONTRIBUTING.md) to contribute.
## Installation
@@ -146,13 +89,9 @@ For other distribution, please see the [install guide](https://nmstate.io/user/i
* [nmstatectl user guide](https://nmstate.github.io/cli_guide.html)
* nmstatectl man page: `man nmstatectl`
-## Limitations
-
-* The maximum supported number of interfaces in a single desire state is 1000.
-
## Changelog
Please refer to [CHANGELOG](CHANGELOG)
-
[mailing_list]: https://lists.fedorahosted.org/admin/lists/nmstate-devel.lists.fedorahosted.org
+[github_issue_url]: https://github.com/nmstate/nmstate/issues