diff --git a/README.md b/README.md index 0a156a9..cb82583 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,38 @@ # popupswitcher -Popup tasklist switcher for awesomewm \ No newline at end of file +Popup tasklist switcher for awesomewm + +## Usage +`require` the library: + +``` +local switcherpopup = require("switcherpopup") +``` + +Add one for each screen: + +``` + local tasklist = switcherpopup.new(s) +``` + +Add some buttons to show and hide it: + +``` + switcher_button:buttons(gears.table.join( + switcher_button:buttons(), + awful.button({}, 1, nil, function() + tasklist:toggle() + end) + )) +``` + +## Configuration + +``` +switcherpopup.iconSize = 128, +switcherpopup.systraySize = 64, +switcherpopup.buttonSize = 96, +switcherpopup.spacing = 5, +switcherpopup.defaultLayout = awful.layout.suit.max, +switcherpopup.iconPath = gears.filesystem.get_configuration_dir() .. "/switcherpopup/" +```