diff --git a/ChangeLog b/CHANGES similarity index 100% rename from ChangeLog rename to CHANGES diff --git a/README b/README index a3e081c..8ccece2 100644 --- a/README +++ b/README @@ -12,12 +12,13 @@ widgets. You can read more about why and how it was written, here: Usage ----- -To use vicious, edit init.lua and comment out all the widgets you -don't need, from the "Configure widgets" list. Then add: +To use vicious, copy it to the ~/.config/awesome directory and edit +init.lua to comment out all the widgets you don't need, from the +"Configure widgets" list. Then add: require("vicious") -... to the top of your rc.lua. Once you create a widget (as a: +...to the top of your rc.lua. Once you create a widget (as a: textbox, graph or a progressbar) call vicious.register() to register it with vicious: @@ -219,7 +220,7 @@ File system widget Battery widget batwidget = widget({type = 'progressbar',name = 'batwidget'}) -- configure the progressbar and bar properties, then register with: - vicious.register(batwidget,vicious.widgets.bat,'$1',60,fswidget,'BAT0') + vicious.register(batwidget,vicious.widgets.bat,'$2',60,batwidget,'BAT0') - executed every 60 seconds, feeds the "batwidget" progressbar, provides "BAT0" battery ID as an argument