Documentation cleanup, etc

README.md

@@ -7,45 +7,49 @@ It is less than 300 lines. It can go anywhere bash will, and will comfortably li
 your dotfiles. Compare with [tinty](https://github.com/tinted-theming/tinty).
 
 ## Installation
-Clone the repo and add symlink it to somewhere in your PATH. Pick your poison
+Clone the repo with submodules
 ```
+git clone --recurse-submodules https://git.sys42.net/dakedres/shchemes.git
+```
+Add symlink it to somewhere in your PATH. Pick your poison
+```sh
 ln -s $PWD/shchemes ~/bin/shchemes
 ln -s $PWD/shchemes ~/.local/bin/shchemes
 ```
 
-Install your favorite base16 themes from tinted-themes:
-```
-shchemes install_tinted_scheme monokai
-```
-
-If you just want a bunch of themes to play with, try installing them all:
-```
-shchemes install_all_tinted_schemes
-```
-
 ## Usage
-Shchemes can be used as a command or sourced to gain access to it's underlying functions.
+Install your favorite base16 themes from tinted-themes:
+```sh
+shchemes install_tinted_scheme --scheme=monokai
+```
+You can also exclude --scheme from any of these commands and it will read from your `SCHEME` environment variable.
 
-In the terminal:
+Append your theme to a config
 ```sh
 shchemes --scheme=base16:monokai create_theme kitty >> ~/.config/kitty/kitty.conf
 ```
+
 If you want to be able to hotswap themes, you'll probably need to use injection.
 ```sh
-echo "#START SHCHEMES BLOCK : create_theme kitty" >> ~/.config/kitty/kitty.conf
-shchemes --scheme=base16:monokai inject ~/.config/kitty/kitty.conf
+echo "#START SHCHEMES BLOCK : shchemes create_theme kitty" >> ~/.config/kitty/kitty.conf # Add the comment for the injection block
+shchemes --scheme=base16:monokai inject ~/.config/kitty/kitty.conf # Inject the theme
 ```
 
-In a script:
+Here's an example script:
 ```bash
-source shchemes --scheme=base16:monokai
+export SCHEME="base16:horizon-terminal-dark"
 
-inject "$HOME/.config/alacritty/alacritty.toml"
-inject "$HOME/.config/rofi/config.rasi"
+shchemes install_tinted_scheme
+
+shchemes inject "${HOME}/.config/kitty/kitty.conf"
+shchemes inject "$HOME/.config/rofi/config.rasi"
 
 bspwm_theme="$HOME/.config/bspwm/colors"
-create_theme bspwm > "$bspwm_theme"
+shchemes create_theme bspwm > "$bspwm_theme"
 "$bspwm_theme"
+
+shchemes inject "${HOME}/.config/qutebrowser/config.py"
+pkill -HUP qutebrowser # Reload qutebrowser config
 ```
 Note you'll have to add all the comments for where to place the injections
 
@@ -54,5 +58,5 @@ See the [cookbook](./doc/cookbook.md) for some ideas on ways to use Shchemes.
 ## Credits
 This software is a work of opportunism
 
-- mo - Mustache templates in bash. Shchemes wouldn't be possible without it.
-- tinted-theming/schemes - Pretty much all the base16 themes
+- [mo](https://github.com/tests-always-included/mo) - Mustache templates in bash. Shchemes wouldn't be possible without it.
+- [tinted-theming/schemes](https://github.com/tinted-theming/schemes) - Pretty much all the base16 themes