From: Andy Jackson <redacted>
Date: Fri, 1 Mar 2024 13:38:07 +0000 (+0000)
Subject: static-neighbor-reports: Update README.md
X-Git-Url: http://git.99rst.org/?a=commitdiff_plain;h=afcd6ac423fb9a242cea73c3d6cda340a8d4fce6;p=openwrt-packages.git

static-neighbor-reports: Update README.md

Define VAP on first use and fix some typos.

Maintainer: @blocktrron
Compile tested: n/a readme
Run tested: n/a readme

Description: Define VAP on first use and fix some typos.

Signed-off-by: Andy Jackson 33336318+andybjackson@users.noreply.github.com

Signed-off-by: Andy Jackson <redacted>
---

diff --git a/net/static-neighbor-reports/README.md b/net/static-neighbor-reports/README.md
index 575d28247..062fec7f0 100644
--- a/net/static-neighbor-reports/README.md
+++ b/net/static-neighbor-reports/README.md
@@ -3,14 +3,15 @@ The `static-neighbor-reports` package allows a user to configure static neighbor
 are available for clients to be polled in case they support IEEE802.11k. This greatly improves
 the wireless experiences in terms of mobility.
 
-Make sure to enable `ieee80211k` for each VAP neighbor reports should be installed to.
+Make sure to enable `ieee80211k` for each Virtual Access Point (VAP) neighbor reports should be
+installed to.
 
 ## Configuring
 The uci config name is `static-neighbor-report`. There's currently only the section
 type `neighbor`.
 
 ### neighbor
-The followign options are supported for `neighbor` sections:
+The following options are supported for `neighbor` sections:
 
 #### neighbor_report
 This is the binary neighbor report element from a foreign AP. It is required for each neighbor.
@@ -27,7 +28,7 @@ the first 6 bytes of the binary neighbor report element.
 The SSID of the foreign AP. This option can be omitted, in case it matches the SSID used on the local AP.
 
 #### iface
-Space seperated list of hostapd interfaces the neighbor should be installed to.
+Space separated list of hostapd interfaces the neighbor should be installed to.
 
 ## Retrieving neighbor information
 To retrieve the neighbor informations of an AP to be isntalled on a foreign AP, make sure the UCI option
@@ -43,7 +44,7 @@ The returned information  follows this format:
     "value": [
         "<BSSID>",
         "<SSID>",
-        "<Neighbot report element>"
+        "<Neighbor report element>"
     ]
 }
 ```