From 786a27c7b7007e23c21e0bc02ccf65f6ed36432e Mon Sep 17 00:00:00 2001
From: XeonSquared <redtailedairways@gmail.com>
Date: Fri, 4 Mar 2022 10:03:35 +1100
Subject: [PATCH] add usage info

---
 README.md | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9bfd6e1..a3b9144 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,41 @@
 # awesome-powermenu
 
-Simple popup power menu for awesomewm
\ No newline at end of file
+Simple popup power menu for awesomewm
+
+## Usage
+
+`require` the library:
+
+```
+local powermenu = require "awesome-powermenu"
+```
+
+Initialise the menu:
+
+```
+powermenu.new()
+```
+
+Bind it to something:
+
+```
+global_key({modkey}, "p", function() powermenuPopup:toggle() end,
+           "show power menu", "launcher")
+```
+
+## Configuration
+
+```
+powermenu.buttonsize = 128,
+powermenu.spacing = 5,
+powermenu.iconPath = gears.filesystem.get_configuration_dir() .. "/powermenu/",
+powermenu.lock = function()
+ -- your lock function here
+end,
+powermenu.suspend = function()
+ -- your suspend function here
+end
+powermenu.poweroff = function()
+ -- your power off function here
+end
+```