readme: add initial README

This commit is contained in:
David Bauer
2022-02-07 21:05:14 +01:00
parent 6aebb75cec
commit 96976ba258

28
README.md Normal file
View File

@@ -0,0 +1,28 @@
# usteer
usteer is a client steering daemon written for OpenWrt.
Its goal is to optimize roaming behavior of wireless clients (STAs) in a ESS consisting of multiple BSS / APs.
## Functions
- Synchronization of Neighbor Reports between multiple APs
- Policy-based decisions for probe- / association- / authentication requests received from STAs
- Requesting clients to roam to a different BSS based on SNR / signal-level
- Channel-load based client steering to different BSS
## Installation
usteer is available from the OpenWrt packages feed and can be installed on devices running OpenWrt 21.02+ using opkg:
```
opkg update; opkg install usteer
```
## Submitting patches
usteer patches are welcome on the openwrt-devel mailing list.
Before submitting patches, check out OpenWrts guide on submission policies.
Make sure to add a `usteer` subject prefix using the `--subject-prefix` option when exporting the patch with `git format-patch`.