From 65534e966cca3103353c8d1452c2549e3d3ab1e4 Mon Sep 17 00:00:00 2001 From: Steven Polley Date: Sat, 1 Jul 2023 10:25:00 -0600 Subject: [PATCH] Add example usage to readme --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a8a97c1..05cca62 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,26 @@ # embedded-bt-rssi-monitor -A bluetooth RSSI monitor to run on a tiny system such as a microcontroller or single board computer. \ No newline at end of file +A bluetooth RSSI monitor to run on a tiny system such as a microcontroller or single board computer. + + +### Usage + +Configure env.sh with the devices you want to monitor. The environment variables must have an _%d suffix, in series, starting from 0. + +```bash +#/bin/bash + +export btmacaddress_0="69:42:69:FF:04:20" # your phone +export btmacaddress_1="0F:F0:0F:F6:44:55" # your smart watch +export btmacaddress_2="0F:44:24:F5:69:69" # your tablet + +``` + +Then source the env.sh file to load the variables, build the program with go and then run it. + +```bash + +source env.sh +go build . && ./embedded-bt-rssi-monitor + +``` \ No newline at end of file