From 96976ba25884dcd0e19578b9a2c94153d9045913 Mon Sep 17 00:00:00 2001 From: David Bauer Date: Mon, 7 Feb 2022 21:05:14 +0100 Subject: [PATCH] readme: add initial README --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..502ac0d --- /dev/null +++ b/README.md @@ -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`. -- 2.30.2