From de21d556eeb5419a7fe4a87881ecce630b0c9657 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Linus=20L=C3=BCssing?= <linus.luessing@c0d3.blue> Date: Sun, 31 Dec 2023 07:10:20 +0100 Subject: [PATCH] docs: fix headings in README.md The newly added information is way too verbose and non-practical for a "Getting started". Therefore adding an "Overview" heading and moving the "Getting started" back to where it originally was. --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 43951640..b35035ab 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Gluon is a firmware framework to build preconfigured OpenWrt images for public mesh networks. -## Getting started +## Overview Gluon provides an easy-to-use firmware for a public, decentral WLAN and/or wire based mesh network. Common network capable devices, like smartphones, laptops or desktop PCs can connect to the mesh network and communicate over it, without the need of passwords for access and without the need of installing special software. @@ -35,6 +35,7 @@ Supported protocols for node-to-node connections: * WAN: VPNs via fastd and Wireguard * LAN: via VXLAN +## Getting started We have a huge amount of documentation over at https://gluon.readthedocs.io/. -- GitLab