X-Git-Url: https://tinc-vpn.org/git/browse?p=tinc;a=blobdiff_plain;f=README.md;fp=README.md;h=c3dcdcf99133625d9f808bf25472b8a01a8e0cbc;hp=5124881ffaf0493c8024d200066f5a2e5402f198;hb=09f036b3aee79d5a5357ef670924ab49de0378dd;hpb=1287fc13ccdf96cd18a391d53ce9b47c29b198e2 diff --git a/README.md b/README.md index 5124881f..c3dcdcf9 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # About tinc -Tinc is a peer-to-peer VPN daemon that supports VPNs with an arbitrary number -of nodes. Instead of configuring tunnels, you give tinc the location and -public key of a few nodes in the VPN. After making the initial connections to -those nodes, tinc will learn about all other nodes on the VPN, and will make -connections automatically. When direct connections are not possible, data will -be forwarded by intermediate nodes. +Tinc is a peer-to-peer VPN daemon that supports VPNs with an arbitrary number of +nodes. Instead of configuring tunnels, you give tinc the location and public key +of a few nodes in the VPN. After making the initial connections to those nodes, +tinc will learn about all other nodes on the VPN, and will make connections +automatically. When direct connections are not possible, data will be forwarded +by intermediate nodes. Tinc can operate in several routing modes. In the default mode, "router", every node is associated with one or more IPv4 and/or IPv6 Subnets. The other two @@ -17,15 +17,15 @@ Ethernet network switch or hub. Please note that this is NOT a stable release. Until version 1.1.0 is released, please use one of the 1.0.x versions if you need a stable version of tinc. -Although tinc 1.1 will be protocol compatible with tinc 1.0.x, the -functionality of the tinc program may still change, and the control socket -protocol is not fixed yet. +Although tinc 1.1 will be protocol compatible with tinc 1.0.x, the functionality +of the tinc program may still change, and the control socket protocol is not +fixed yet. # Documentation -See [QUICKSTART.md](QUICKSTART.md) for a quick guide to get tinc up and -running. Read the [manual](https://www.tinc-vpn.org/documentation-1.1/) for -more detailed information. +See [QUICKSTART.md](QUICKSTART.md) for a quick guide to get tinc up and running. +Read the [manual](https://www.tinc-vpn.org/documentation-1.1/) for more detailed +information. # Getting tinc @@ -43,8 +43,8 @@ Windows here: - [latest release](https://github.com/gsliepen/tinc/releases/latest) Note that these packages have not been heavily tested and are not officially -supported by the project. Use them at your own risk. You are advised to use -tinc shipped by your distribution, or build from source. +supported by the project. Use them at your own risk. You are advised to use tinc +shipped by your distribution, or build from source. ## Build it from source @@ -53,11 +53,12 @@ install tinc from source. # Copyright -tinc is Copyright © 1998-2022 Ivo Timmermans, Guus Sliepen , and others. +tinc is Copyright © 1998-2022 Ivo Timmermans, Guus Sliepen , +and others. For a complete list of authors see the [AUTHORS](AUTHORS) file. -This program is free software; you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2 of the License, or (at -your option) any later version. See the file COPYING for more details. +This program is free software; you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free Software +Foundation; either version 2 of the License, or (at your option) any later +version. See the file COPYING for more details.