From b662f2e10d68c23422eb56af61ff553b51b6923c Mon Sep 17 00:00:00 2001
From: Ethan Edwards <ethancarteredwards@gmail.com>
Date: Mon, 10 Aug 2020 08:04:51 -0400
Subject: [PATCH] documentation

---
 INSTALL.md           | 1 +
 README.md            | 1 +
 scripts/cpu_info.sh  | 2 ++
 scripts/gpu_usage.sh | 2 ++
 scripts/ram_info.sh  | 2 ++
 5 files changed, 8 insertions(+)

diff --git a/INSTALL.md b/INSTALL.md
index a24609f..03362b6 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -21,6 +21,7 @@ Customize the status bar by adding any of these lines to your .tmux.conf as desi
 * Switch from default fahrenheit to celsius: `set -g @dracula-show-fahrenheit false`
 * Enable powerline symbols: `set -g @dracula-show-powerline true`
 * Switch powerline symbols `set -g @dracula-show-left-sep ` for left and `set -g @dracula-show-right-sep ` for right symbol (can set any symbol you like as seperator)
+* Adjust the refresh rate for the bar `set -g @dracula-refresh-rate 5` the default is 5, it can accept any number
 * Enable military time: `set -g @dracula-military-time true`
 * Disable timezone: `set -g @dracula-show-timezone false`
 * Switch the left smiley icon `set -g @dracula-show-left-icon session` it can accept `session`, `smiley`, `window`, or any character.
diff --git a/README.md b/README.md
index f8ec8a9..666ead6 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,7 @@ Configuration and options can be found at [draculatheme.com/tmux](https://dracul
 * Current location based on network with temperature and forecast icon (if available)
 * Network connection status and SSID
 * Battery percentage and AC power connection status
+* Refresh rate control
 * CPU usage
 * RAM usage
 * GPU usage
diff --git a/scripts/cpu_info.sh b/scripts/cpu_info.sh
index 34635c0..c765d16 100755
--- a/scripts/cpu_info.sh
+++ b/scripts/cpu_info.sh
@@ -1,5 +1,6 @@
 #!/usr/bin/env bash
 
+# function for getting the refresh rate
 get_tmux_option() {
   local option=$1
   local default_value=$2
@@ -32,6 +33,7 @@ get_percent()
 
 main()
 {
+	# storing the refresh rate in the variable RATE, default is 5
 	RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
 	cpu_percent=$(get_percent)
 	echo "CPU $cpu_percent"
diff --git a/scripts/gpu_usage.sh b/scripts/gpu_usage.sh
index 3b783ee..79b60f1 100755
--- a/scripts/gpu_usage.sh
+++ b/scripts/gpu_usage.sh
@@ -1,5 +1,6 @@
 #!/usr/bin/env bash
 
+# function for getting the refresh rate
 get_tmux_option() {
   local option=$1
   local default_value=$2
@@ -38,6 +39,7 @@ get_gpu()
 }
 main()
 {
+	# storing the refresh rate in the variable RATE, default is 5
 	RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
 	gpu_usage=$(get_gpu)
 	echo "GPU $gpu_usage"
diff --git a/scripts/ram_info.sh b/scripts/ram_info.sh
index 30f905c..141e7a6 100755
--- a/scripts/ram_info.sh
+++ b/scripts/ram_info.sh
@@ -1,5 +1,6 @@
 #!/usr/bin/env bash
 
+# function for getting the refresh rate
 get_tmux_option() {
   local option=$1
   local default_value=$2
@@ -48,6 +49,7 @@ get_percent()
 
 main()
 {
+	# storing the refresh rate in the variable RATE, default is 5
 	RATE=$(get_tmux_option "@dracula-refresh-rate" 5)
 	ram_percent=$(get_percent)
 	echo "RAM $ram_percent"