diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 34ebccc..7caa933 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,5 +1,4 @@ # These are supported funding model platforms -github: pirate -patreon: theSquashSH -custom: https://paypal.me/NicholasSweeting +github: zx2c4 +patreon: zx2c4 diff --git a/README.md b/README.md index e7f65af..2895b91 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@
-# The Missing Wireguard Documentation +# Some Unofficial WireGuard Documentation -

+

-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/), [Edge Security](https://www.edgesecurity.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.
@@ -21,17 +21,16 @@ Nicer HTML page version: https://docs.sweeting.me/s/wireguard --- -[WireGuard](https://www.wireguard.com/) is a BETA/WIP 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. - -This is my attempt at writing "The Missing Wireguard Documentation" to make up for the somewhat sparse official docs on an otherwise great piece of software. +[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) - Main Git repo: https://git.zx2c4.com/WireGuard/ -- Github Mirror: https://github.com/WireGuard/WireGuard +- GitHub Mirror: https://github.com/WireGuard/WireGuard - Mailing List: https://lists.zx2c4.com/mailman/listinfo/wireguard **WireGuard Goals** @@ -57,13 +56,16 @@ See https://github.com/pirate/wireguard-docs for example code and documentation