hopefully better documentation

README.md

@@ -79,42 +79,7 @@ bling.module.tabbed.iter()  -- iterates through the currently focused tabbing gr
 
 
 ### 🌈 Theme variables
-Put those variables in your ``theme.lua`` if you want to edit appearance and some functionalities.
-
-For the **mstab layout**:
-```lua
-mstab_bar_ontop           -- allow the bar to be ontop of clients (default -> false)
-mstab_tabbar_position     -- set to "bottom" for tabbar at button
-mstab_bar_height          -- height of the tabbar
-mstab_border_radius       -- corners radius of the tabbar
-mstab_font                -- font of the tabbar
-mstab_bg_focus            -- background color of the focused client on the tabbar
-mstab_fg_focus            -- background color of the focused client on the tabbar
-mstab_bg_normal           -- foreground color of unfocused clients on the tabbar
-mstab_fg_normal           -- foreground color of unfocused clients on the tabbar
-```
-
-For **window swallowing**:
-```lua
-dont_swallow_classname_list   -- list of client classnames that shouldn't be swallowed
-                              -- default is {"firefox", "Gimp"}
-dont_swallow_filter_activated -- whether the filter is activated or not
-                              -- default is false.
-                              -- Set it to true if you want to filter clients that should be swallowed
-```
-
-
-For **flash focus**:
-```lua
-flash_focus_start_opacity -- the starting opacity (default 0.6)
-flash_focus_step          -- the step of the animation (default 0.01)
-```
-
-For **tabbed**:
-```lua
-tabbed_spawn_into_tab     -- set to true if you want new windows to spawn into your focused tabbing
-
-```
+You will find a list of all theme variables that are used in bling and comments on what they do in the `theme-car-template.lua` file - ready for you to copy them into your `theme.lua`. Theme variables are not only used to change the appearance of some features but also to adjust the functionality of some modules. So it is worth it to take a look at them.
 
 ## 😲 Preview
 
@@ -136,7 +101,7 @@ screenshots by me
 ### Flash Focus
 ![](https://imgur.com/5txYrlV.gif)
 
-git by [javacafe](https://github.com/JavaCafe01)
+gif by [javacafe](https://github.com/JavaCafe01)
 
 ### Wind swallowing
 ![](https://media.discordapp.net/attachments/635625813143978012/769180910683684864/20-10-23-14-40-32.gif)
@@ -145,7 +110,7 @@ gif by me :)
 
 ## TODO
 - [ ] Scratchpad module
-- [ ] Some more documentation on the tabbed module
+- [x] Some more documentation on the tabbed module
 - [x] Add a cool alternative tabbar style  
 - [x] Add another cool tabbar style (we need more styles)
 - [ ] Make the mstab layout compatible with vertical tabbars (left and right)

theme-var-template.lua

@@ -0,0 +1,51 @@
+--[[ Bling theme variables template
+
+This file has all theme variables of the bling module.
+Every variable has a small comment on what it does.
+You might just want to copy that whole part into your theme.lua and start adjusting from there.
+
+--]]
+
+
+-- window swallowing
+theme.dont_swallow_classname_list    = {"firefox", "Gimp"}      -- list of class names that should not be swallowed
+theme.dont_swallow_filter_activated  = true                     -- whether the filter above should be active 
+
+-- flash focus
+theme.flash_focus_start_opacity = 0.6       -- the starting opacity
+theme.flash_focus_step = 0.01               -- the step of animation
+
+-- tabbed
+theme.tabbed_spawn_in_tab = false           -- whether a new client should spawn into the focused tabbing container 
+
+-- tabbar general
+theme.tabbar_ontop  = false
+theme.tabbar_radius = 0                     -- border radius of the tabbar
+theme.tabbar_style = "default"              -- style of the tabbar ("default", "boxes" or "modern")
+theme.tabbar_font = "Sans 11"               -- font of the tabbar
+theme.tabbar_size = 40                      -- size of the tabbar
+theme.tabbar_position = "top"               -- position of the tabbar
+theme.tabbar_bg_normal = "#000000"          -- background color of the focused client on the tabbar
+theme.tabbar_fg_normal = "#ffffff"          -- foreground color of the focused client on the tabbar
+theme.tabbar_bg_focus  = "#1A2026"          -- background color of unfocused clients on the tabbar
+theme.tabbar_fg_focus  = "#ff0000"          -- foreground color of unfocused clients on the tabbar
+
+-- mstab
+theme.mstab_bar_ontop = false               -- whether you want to allow the bar to be ontop of clients
+theme.mstab_bar_padding = "default"         -- how much padding there should be between clients and your tabbar
+                                            -- by default it will adjust based on your useless gaps. 
+                                            -- If you want a custom value. Set it to the number of pixels (int)
+
+-- the following variables are still for mstab
+-- you only need to set them if you want your mstab layout tabbar to have a different
+-- look then your tabbed module tabbar. By default they will look the same.
+theme.mstab_border_radius = 0               -- border radius of the tabbar
+theme.mstab_tabbar_style = "default"        -- style of the tabbar ("default", "boxes" or "modern")
+theme.mstab_font = "Sans 11"                -- font of the tabbar
+theme.mstab_bar_height = 40                 -- height of the tabbar
+theme.mstab_tabbar_position = "top"         -- position of the tabbar (mstab currently does not support left,right)
+theme.mstab_bg_focus    = "#000000"         -- background color of the focused client on the tabbar
+theme.mstab_fg_focus    = "#ffffff"         -- foreground color of the focused client on the tabbar
+theme.mstab_bg_normal   = "#1A2026"         -- background color of unfocused clients on the tabbar
+theme.mstab_fg_normal   = "#ff0000"         -- foreground color of unfocused clients on the tabbar
+