Merge branch 'master' into dockerize

Merging  master into dockerize

README.md

@@ -17,18 +17,47 @@ A terminal-style home page replicating the tree command.
   </h1>
 </div>
 
+# Usage
+## Installation
+To install StartTree for the first time, run the following commands:  
+(Note: If the `~/.config/StartTree` directory already exists, `init.py` will not execute to prevent accidentally overwriting a custom config. )
+```
+git clone https://github.com/Paul-Houser/StartTree.git
+cd StartTree
+./init.py
+./generate.py
+```
+This will create the directory `~/.config/StartTree` containing the default `config.yaml`, as well as generate the html/css, which you can view by pointing your browser at `$HOME/.cache/StartTree/index.html`.
 
+## Config
+The config should be placed in `~/.config/StartTree/config.yaml`
+
+## Updating the HTML
+To re-generate the html/css after editing the config, navigate to the `StartTree` directory and execute `./generate.py`.
+
+# Example Config
 ```yaml
-font_size: 15
+font_size: 22 # specify font size
-theme: void
+theme: void # specify the name of a theme in the themes/ directory, or use 'pywal'
-
+tree_1: # each column should be named 'tree_X' where X is unique for each tree.
-tree_1:
+  general: # Header name
-  general:
+    github: "https://www.github.com/" # Link-text: url
-    google: "https://www.google.com/"
+    gmail: "https://mail.google.com/"
-    youtube: "https://www.youtube.com/"
   reddit:
-    homepage: "https://www.reddit.com/"
+    # the following is an example of naming a link something with a space,
+    # or containing characters that cannot be in a yaml variable name.
+    frontpage: 
+      - "https://www.reddit.com/"
+      - "front page" # 
     unixporn: "https://www.reddit.com/r/unixporn/"
+tree_2:
+  other:
+    archwiki: 
+      - "https://archlinux.org/"
+      - "arch wiki"
+    hulu: "https://www.hulu.com/"
+    netflix: "https://www.netflix.com/"
+    youtube: "https://www.youtube.com/"
 ```
 
 # Themes