readme.md

An explanation of the file and what it does.

team_tomodachi/readme.md

@@ -0,0 +1,17 @@
+# Team Tomodachi Module!
+
+What is this for? It adds a little animated cheering ascii 
+
+--insert gif here--
+
+This script creates a temporary file in /tmp/ to manage a variable in order to increment and loop the ASCII for animation since Polybar doesn't have an easy way to loop. At the interval duration, in this case 0.1 or 0.2, it will read the script from the top to the bottom and so if you define a variable inside the script itself, it will redefine the variable and ruin any increment you were hoping to use. This way, you can use a loop and increment/decrement to your hearts desire!
+
+# config module information
+
+```ini
+[module/team_tomodachi]
+; On each interval (100ms = 0.1) it will reload the script, increment and echo
+type = custom/script
+exec = $HOME/.config/polybar/polybar-scripts/team_tomodachi_ascii.sh
+interval = 0.2
+```