Add more docs and fix readme

This commit is contained in:
Gokul Swami 2021-04-16 14:31:03 -07:00
parent 5b6cab4099
commit ae5bcde75e
2 changed files with 1 additions and 12 deletions

View File

@ -25,17 +25,6 @@ All documentation, instructions, and previews are [here](https://nooo37.github.i
- Widgets
- Tag Preview
## TODO
- [ ] Add a built-in option to animate scratchpads with [awestore](https://github.com/K4rakara/awestore)
- [ ] Add external sources management for the wallpaper module (URLs, RSS feeds, NASA picture of the day, ...)
- [x] Scratchpad 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)
- [x] Make the mstab layout compatible with vertical tabbars (left and right)
- [x] Add option to mstab layout to not shrink windows down when they are in the tabbed pane and unfocused (for example for people using transparent terminals)
- [x] Keyboard based option to add windows to a tabbing object
All naming credit goes to javacafe.
## Contributing

View File

@ -41,7 +41,7 @@ local term_scratch = bling.module.scratchpad:new {
autoclose = true, -- Whether it should hide itself when losing focus
floating = true, -- Whether it should be floating
geometry = {x=360, y=90, height=900, width=1200}, -- The geometry in a floating state
reapply = false, -- Whether all those properties should be reapplied on every new opening of the scratchpad
reapply = true, -- Whether all those properties should be reapplied on every new opening of the scratchpad (MUST BE TRUE FOR ANIMATIONS)
dont_focus_before_close = false, -- When set to true, the scratchpad will be closed by the toggle function regardless of whether its focused or not. When set to false, the toggle function will first bring the scratchpad into focus and only close it on a second call
awestore = {x = anim_x, y = anim_y} -- Optional. This is how you can pass in the stores for animations. If you don't want animations, you can ignore this option.
}