docs

README.md

@@ -1,3 +1,20 @@
 # awesome-navbar
 
-Touchscreen navbar for awesomewm
+Touchscreen navbar for awesomewm, ties [awesome-switcherpopup](https://git.shadowkat.net/izaya/awesome-switcherpopup), awesome-launcherpopup and [vkbd](https://codeberg.org/fangchar/vkbd) together.
+
+## Usage
+
+```
+local navbar = require "awesome-navbar"
+awful.screen.connect_for_each_screen(function(s)
+  navbar.new(screen)
+end
+```
+
+## Configuration
+
+```
+navbar.iconSize = 96
+navbar.iconPath = gears.filesystem.get_configuration_dir() .. "/awesome-navbar/"
+navbar.launcher = launcher or "xfce4-appfinder"
+```