aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..466f7dd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# Miniwifi
+
+Tiny wireless access status monitoring app, outputs assigned IP and SSID
+attached to wlan0 each second. Output color changes depending on whether an
+internet connection is available.
+
+`wifi-scan` library was copied from
+[here](https://github.com/bmegli/wifi-scan/tree/master).
+
+Meant to be used with status bar apps like i3-blocks.