static-neighbor-reports: Update README.md
authorAndy Jackson <[email protected]>
Fri, 1 Mar 2024 13:38:07 +0000 (13:38 +0000)
committerDavid Bauer <[email protected]>
Thu, 22 May 2025 00:37:29 +0000 (02:37 +0200)
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 [email protected]
Signed-off-by: Andy Jackson <[email protected]>
net/static-neighbor-reports/README.md

index 575d28247c447dc3791d1afdb297c99d76c2f771..062fec7f0403ba54c80aee36354901bf41b01e1e 100644 (file)
@@ -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>"
     ]
 }
 ```