policy: improve readability
[project/usteer.git] / README.md
1 # usteer
2
3 usteer is a client steering daemon written for OpenWrt.
4
5 Its goal is to optimize roaming behavior of wireless clients (STAs) in a ESS consisting of multiple BSS / APs.
6
7 ## Functions
8
9 - Synchronization of Neighbor Reports between multiple APs
10 - Policy-based decisions for probe- / association- / authentication requests received from STAs
11 - Requesting clients to roam to a different BSS based on SNR / signal-level
12 - Channel-load based client steering to different BSS
13
14 ## Installation
15
16 usteer is available from the OpenWrt packages feed and can be installed on devices running OpenWrt 21.02+ using opkg:
17
18 ```
19 opkg update; opkg install usteer
20 ```
21
22 ## Submitting patches
23
24 usteer patches are welcome on the openwrt-devel mailing list.
25
26 Before submitting patches, check out OpenWrts guide on submission policies.
27
28 Make sure to add a `usteer` subject prefix using the `--subject-prefix` option when exporting the patch with `git format-patch`.