Skip to content

Commit 6ce7f5a

Browse files
authored
Update README.md
1 parent ecd11fd commit 6ce7f5a

File tree

1 file changed

+62
-17
lines changed

1 file changed

+62
-17
lines changed

README.md

Lines changed: 62 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,39 @@
1-
# RiV-mesh first self arranging mesh network with link aggregation.
1+
# RiV-mesh - Decentralized IPv6 Mesh Network
22

33
## Introduction
44

5-
RiV-mesh is an implementation of a fully end-to-end encrypted IPv6
6-
network, created in the scope to produce the Transport Layer for RiV Chain Blockchain,
7-
also to facilitate secure conectivity between a wide spectrum of endpoint devices like IoT devices,
5+
RiV-mesh is the legacy implementation of a fully end-to-end encrypted IPv6
6+
mesh network, designed to provide secure connectivity between a wide spectrum of endpoint devices like IoT devices,
87
desktop computers or even routers.
98
It is lightweight, self-arranging, supported on multiple
109
platforms and allows pretty much any IPv6-capable application
11-
to communicate securely with other RiV-mesh nodes.
12-
RiV-mesh does not require you to have IPv6 Internet connectivity - it also works over IPv4.
10+
to communicate securely with other network nodes.
11+
12+
**Note**: RiV-mesh is now maintained for legacy compatibility. For new deployments, we recommend using [v6Space™](https://github.com/RiV-chain/v6Space) - the next-generation mesh networking platform with enhanced features, modern architecture, agentic capabilities, and MCP (Model Context Protocol) tools for AI agent communication and autonomous operations.
13+
14+
## Relationship to v6Space™
15+
16+
RiV-mesh is the **legacy version** of the mesh networking technology that has evolved into **v6Space™**:
17+
18+
### RiV-mesh (Legacy)
19+
- **Status**: Legacy maintenance mode
20+
- **License**: LGPLv3 only
21+
- **Features**: Core mesh networking functionality
22+
- **Use Case**: Existing deployments, compatibility
23+
24+
### v6Space™ (Current)
25+
- **Status**: Active development
26+
- **License**: Dual-license (LGPLv3 + CC BY-NC 4.0)
27+
- **Features**: Enhanced mesh networking + modern UI + MCP support + agentic capabilities
28+
- **Agentic Features**: AI agent communication, autonomous operations, Web3 integration
29+
- **MCP Tools**: Model Context Protocol integration for AI model communication
30+
- **Use Case**: New deployments, modern applications, AI agent networks, Web3 infrastructure
31+
32+
**Migration**: RiV-mesh configurations are compatible with v6Space™. Simply replace the binary and continue using your existing `mesh.conf` files.
33+
34+
## Core Functionality
35+
36+
RiV-mesh provides the decentralized IPv6 mesh overlay network infrastructure for applications like CupLink™, which requires a VPN service to establish the mesh network environment for peer-to-peer communication.
1337

1438
## Supported Platforms
1539

@@ -25,7 +49,7 @@ or tools in the `contrib` folder.
2549
If you want to build from source, as opposed to installing one of the pre-built
2650
packages:
2751

28-
1. Install [Go](https://golang.org) (requires Go 1.18 or later)
52+
1. Install [Go](https://golang.org) (requires Go 1.19 or later)
2953
2. Clone this repository
3054
2. Run `./build`
3155

@@ -100,13 +124,21 @@ Documentation is available [on our website](https://riv-chain.github.io/RiV-mesh
100124

101125
<img width="253" alt="DDNS" src="https://github.com/RiV-chain/RiV-mesh/assets/743622/05757b9f-2053-4503-9037-24e5ff992554">
102126

103-
## Community
127+
## Company Information
128+
129+
**RiV-mesh** is developed by **RiV Chain™ Limited**, an Ireland-based FinTech and infrastructure R&D company focused on decentralized networking and agentic systems.
130+
131+
- **Company**: RiV Chain™ Limited
132+
- **Location**: Ireland
133+
- **Focus**: Decentralized mesh networking, AI agent coordination, distributed identity, Web3 infrastructure
134+
- **Specialization**: Agentic Web technologies, MCP tools, autonomous AI agent communication
135+
- **Website**: [rivchain.org](https://rivchain.org)
136+
- **Contact**: For technical support and licensing inquiries
137+
104138

105-
Feel free to join us on our [Telegram
106-
channel](https://t.me/rivchain).
107139

108140
## Public peers
109-
If you are operating RiV-mesh peer and may create your pool request with your new per or use existing one https://github.com/RiV-chain/public-peers
141+
If you are operating a RiV-mesh peer, you may create your pull request with your new peer or use existing ones: https://github.com/RiV-chain/public-peers
110142

111143
## Known issues
112144

@@ -141,9 +173,22 @@ Docker interface docker0 is conflicting with SCTP bind process. The issue can be
141173

142174
## License
143175

144-
This code is released under the terms of the LGPLv3, but with an added exception
145-
that was shamelessly taken from [godeb](https://github.com/niemeyer/godeb).
146-
Under certain circumstances, this exception permits distribution of binaries
147-
that are (statically or dynamically) linked with this code, without requiring
148-
the distribution of Minimal Corresponding Source or Minimal Application Code.
149-
For more details, see: [LICENSE](LICENSE).
176+
RiV-mesh is released under the **GNU Lesser General Public License v3.0 (LGPLv3)**:
177+
178+
- **License**: LGPLv3 (standard version, no special exceptions)
179+
- **Commercial Use**: Allowed with full LGPLv3 compliance requirements
180+
- **Source Code**: Available at [GitHub](https://github.com/RiV-chain/v6Space)
181+
- **Compliance**: Users must provide source code and comply with LGPLv3 terms
182+
183+
### Key LGPLv3 Requirements:
184+
- **Source Code Sharing**: Must provide v6Space™ source code when distributing
185+
- **Application Code Sharing**: Must share source code of applications using RiV-mesh
186+
- **Build Instructions**: Must provide installation and build information
187+
- **Modifications**: Any modifications to RiV-mesh must remain open source
188+
189+
For complete licensing details, see:
190+
- [Full LGPLv3 License](LICENSE)
191+
- [v6Space™ License Information](https://rivchain.org/legal/license.html)
192+
- [Component Separation Guide](https://rivchain.org/legal/component-separation.html)
193+
194+
**Note**: RiV-mesh is the legacy version. v6Space™ uses a dual-license model with additional UI components under CC BY-NC 4.0.

0 commit comments

Comments
 (0)