From 3477adff49a07101096a7bfc66fa45c8aa11155b Mon Sep 17 00:00:00 2001 From: Ross Smith II Date: Thu, 2 May 2024 08:56:44 -0700 Subject: [PATCH] docs: Wordwrap at 80 cols, fix typos --- README.md | 823 ++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 579 insertions(+), 244 deletions(-) diff --git a/README.md b/README.md index 9d6c0a8..40b7562 100644 --- a/README.md +++ b/README.md @@ -5,15 +5,21 @@

-API reference guide for WireGuard including Setup, Configuration, and Usage, with examples. +API reference guide for WireGuard including Setup, Configuration, and Usage, +with examples. -All credit goes to the WireGuard project, [zx2c4](https://www.zx2c4.com/) and the [open source contributors](https://github.com/WireGuard/WireGuard/graphs/contributors) for the original software,
this is my solo unofficial attempt at providing more comprehensive documentation, API references, and examples.
+All credit goes to the WireGuard project, [zx2c4](https://www.zx2c4.com/) and +the [open source +contributors](https://github.com/WireGuard/WireGuard/graphs/contributors) for +the original software,
this is my solo unofficial attempt at providing more +comprehensive documentation, API references, and examples.
-Source for these docs, example code, and issue tracker: https://github.com/pirate/wireguard-docs     -Nicer HTML page version: https://docs.sweeting.me/s/wireguard +Source for these docs, example code, and issue tracker: +https://github.com/pirate/wireguard-docs     Nicer HTML page version: +https://docs.sweeting.me/s/wireguard @@ -21,14 +27,26 @@ Nicer HTML page version: https://docs.sweeting.me/s/wireguard --- -[WireGuard](https://www.wireguard.com/) is an open-source VPN solution written in C by [Jason Donenfeld](https://www.jasondonenfeld.com) and [others](https://github.com/WireGuard/WireGuard/graphs/contributors), aiming to fix many of the problems that have plagued other modern server-to-server VPN offerings like IPSec/IKEv2, OpenVPN, or L2TP. It shares some similarities with other modern VPN offerings like [Tinc](https://www.tinc-vpn.org/) and [MeshBird](https://github.com/meshbird/meshbird), namely good cipher suites and minimal config. As of 2020-01 [it's been merged into the 5.6 version of the Linux kernel](https://arstechnica.com/gadgets/2020/01/linus-torvalds-pulled-wireguard-vpn-into-the-5-6-kernel-source-tree/), meaning it will ship with most Linux systems out-of-the-box. +[WireGuard](https://www.wireguard.com/) is an open-source VPN solution written +in C by [Jason Donenfeld](https://www.jasondonenfeld.com) and +[others](https://github.com/WireGuard/WireGuard/graphs/contributors), aiming to +fix many of the problems that have plagued other modern server-to-server VPN +offerings like IPSec/IKEv2, OpenVPN, or L2TP. It shares some similarities with +other modern VPN offerings like [Tinc](https://www.tinc-vpn.org/) and +[MeshBird](https://github.com/meshbird/meshbird), namely good cipher suites and +minimal config. As of 2020-01 [it's been merged into the 5.6 version of the +Linux +kernel](https://arstechnica.com/gadgets/2020/01/linus-torvalds-pulled-wireguard-vpn-into-the-5-6-kernel-source-tree/), +meaning it will ship with most Linux systems out-of-the-box. **Official Links** - Homepage: https://www.wireguard.com - Install: https://www.wireguard.com/install/ - QuickStart: https://www.wireguard.com/quickstart/ -- Manpages: [`wg`](https://manpages.debian.org/testing/wireguard-tools/wg.8.en.html), [`wg-quick`](https://manpages.debian.org/unstable/wireguard-tools/wg-quick.8.en.html) +- Manpages: + [`wg`](https://manpages.debian.org/testing/wireguard-tools/wg.8.en.html), + [`wg-quick`](https://manpages.debian.org/unstable/wireguard-tools/wg-quick.8.en.html) - Main Git repo: https://git.zx2c4.com/WireGuard/ - GitHub Mirror: https://github.com/WireGuard/WireGuard - Mailing List: https://lists.zx2c4.com/mailman/listinfo/wireguard @@ -52,7 +70,8 @@ It's also fast as hell. I routinely get sub 0.5ms pings and 900mbps+ on g # Table of Contents -See https://github.com/pirate/wireguard-docs for example code and documentation source. +See https://github.com/pirate/wireguard-docs for example code and documentation +source.