From e797308eb96021974713e2757c778825555b4de3 Mon Sep 17 00:00:00 2001
From: XeonSquared <redtailedairways@gmail.com>
Date: Thu, 25 Aug 2022 16:34:30 +1000
Subject: [PATCH] docs

---
 README.md | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 8477bcf..38e48b6 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,20 @@
 # awesome-navbar
 
-Touchscreen navbar for awesomewm
\ No newline at end of file
+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"
+```