From f4a4274967837f49f2e6c5f5d02920852a6787c1 Mon Sep 17 00:00:00 2001 From: Vadym Vikulin Date: Thu, 9 Sep 2021 10:21:47 +0300 Subject: [PATCH] Update README.md --- README.md | 42 ++++++++++++++++++++++-------------------- 1 file changed, 22 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index dd1d79c0..03b7ebc7 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,22 @@ -# Mesh +# RiV-mesh [![CircleCI](https://circleci.com/gh/RiV-chain/RiV-mesh.svg?style=shield&circle-token=:circle-token )](https://circleci.com/gh/RiV-chain/RiV-mesh) ## Introduction -Mesh is an early-stage implementation of a fully end-to-end encrypted IPv6 -network. It is lightweight, self-arranging, supported on multiple platforms and -allows pretty much any IPv6-capable application to communicate securely with -other Mesh nodes. Mesh does not require you to have IPv6 Internet -connectivity - it also works over IPv4. +RiV-mesh is an implementation of a fully end-to-end encrypted IPv6 +network, created in the scope to produce the Transport Layer for RiV Chain Blockchain, +also to facilitate secure conectivity between a wide spectrum of endpoint devices like IoT devices, +desktop computers or even routers. +It is lightweight, self-arranging, supported on multiple +platforms and allows pretty much any IPv6-capable application +to communicate securely with other RiV-mesh nodes. +RiV-mesh does not require you to have IPv6 Internet connectivity - it also works over IPv4. ## Supported Platforms -Mesh works on a number of platforms, including Linux, macOS, Ubiquiti +RiV-mesh works on a number of platforms, including Linux, macOS, Ubiquiti EdgeRouter, VyOS, Windows, FreeBSD, OpenBSD and OpenWrt. Please see our [Installation](https://RiV-chain.github.io/installation.html) @@ -41,51 +44,50 @@ To generate static configuration, either generate a HJSON file (human-friendly, complete with comments): ``` -./yggdrasil -genconf > /path/to/yggdrasil.conf +./mesh -genconf > /path/to/mesh.conf ``` ... or generate a plain JSON file (which is easy to manipulate programmatically): ``` -./yggdrasil -genconf -json > /path/to/yggdrasil.conf +./mesh -genconf -json > /path/to/mesh.conf ``` -You will need to edit the `yggdrasil.conf` file to add or remove peers, modify +You will need to edit the `mesh.conf` file to add or remove peers, modify other configuration such as listen addresses or multicast addresses, etc. -### Run Mesh +### Run RiV-mesh To run with the generated static configuration: ``` -./yggdrasil -useconffile /path/to/yggdrasil.conf +./mesh -useconffile /path/to/mesh.conf ``` To run in auto-configuration mode (which will use sane defaults and random keys at each startup, instead of using a static configuration file): ``` -./yggdrasil -autoconf +./mesh -autoconf ``` -You will likely need to run Mesh as a privileged user or under `sudo`, +You will likely need to run RiV-mesh as a privileged user or under `sudo`, unless you have permission to create TUN/TAP adapters. On Linux this can be done -by giving the Mesh binary the `CAP_NET_ADMIN` capability. +by giving the RiV-mesh binary the `CAP_NET_ADMIN` capability. ## Documentation Documentation is available [on our website](https://RiV-chain.github.io). -- [Installing Mesh](https://RiV-chain.github.io/installation.html) -- [Configuring Mesh](https://RiV-chain.github.io/configuration.html) +- [Installing RiV-mesh](https://RiV-chain.github.io/installation.html) +- [Configuring RiV-mesh](https://RiV-chain.github.io/configuration.html) - [Frequently asked questions](https://RiV-chain.github.io/faq.html) - [Version changelog](CHANGELOG.md) ## Community -Feel free to join us on our [Matrix -channel](https://matrix.to/#/#yggdrasil:matrix.org) at `#yggdrasil:matrix.org` -or in the `#yggdrasil` IRC channel on [libera.chat](https://libera.chat). +Feel free to join us on our [Telegram +channel](https://t.me/rivchain). ## License