From ceeb33b17dab11558abfce1a342a1c35c6d3f2ae Mon Sep 17 00:00:00 2001
From: NotAShelf <raf@notashelf.dev>
Date: Sun, 18 May 2025 02:29:45 +0300
Subject: [PATCH] docs: update example config

---
 README.md | 29 +++++++++++++++++++++--------
 1 file changed, 21 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 6adba66..c1aff74 100644
--- a/README.md
+++ b/README.md
@@ -155,7 +155,12 @@ turbo = "auto"
 # Enable or disable automatic turbo management (when turbo = "auto")
 enable_auto_turbo = true
 # Custom thresholds for auto turbo management
-turbo_auto_settings = { load_threshold_high = 70.0, load_threshold_low = 30.0, temp_threshold_high = 75.0 }
+turbo_auto_settings = {
+    load_threshold_high = 70.0,
+    load_threshold_low = 30.0,
+    temp_threshold_high = 75.0,
+    initial_turbo_state = false,  # whether turbo should be initially enabled (false = disabled)
+}
 # Energy Performance Preference
 epp = "performance"
 # Energy Performance Bias (0-15 scale or named value)
@@ -174,7 +179,12 @@ governor = "powersave"
 turbo = "auto"
 # More conservative auto turbo settings on battery
 enable_auto_turbo = true
-turbo_auto_settings = { load_threshold_high = 80.0, load_threshold_low = 40.0, temp_threshold_high = 70.0 }
+turbo_auto_settings = {
+    load_threshold_high = 80.0,
+    load_threshold_low = 40.0,
+    temp_threshold_high = 70.0,
+    initial_turbo_state = false,  # start with turbo disabled on battery for power savings
+}
 epp = "power"
 epb = "balance_power"
 platform_profile = "low-power"
@@ -229,6 +239,8 @@ dynamically controls CPU turbo boost based on:
   exceeds `temp_threshold_high` (default 75°C)
 - **Hysteresis Control**: Prevents rapid toggling by maintaining previous state
   when load is between thresholds
+- **Configurable Initial State**: Sets the initial turbo state via
+  `initial_turbo_state` (default: disabled) before system load data is available
 - **Profile-Specific Settings**: Configure different thresholds for battery vs.
   AC power
 
@@ -314,10 +326,11 @@ While reporting issues, please attach the results from `superfreq debug`.
 Contributions to Superfreq are always welcome! Whether it's bug reports, feature
 requests, or code contributions, please feel free to contribute.
 
-If you are looking to reimplement features from auto_cpufreq, please consider
-opening an issue first and let us know what you have in mind. Certain features
-(such as the system tray) are deliberately ignored, and might not be desired in
-the codebase as they stand.
+> [!NOTE]
+> If you are looking to reimplement features from auto-cpufreq, please consider
+> opening an issue first and let us know what you have in mind. Certain features
+> (such as the system tray) are deliberately ignored, and might not be desired
+> in the codebase as they stand. Please discuss those features with us first :)
 
 ### Setup
 
@@ -332,9 +345,9 @@ nix develop
 ```
 
 Non-Nix users may get the appropriate Cargo and Rust versions from their package
-manager.
+manager, or using something like Rustup.
 
-### Formatting
+### Formatting & Lints
 
 Please make sure to run _at least_ `cargo fmt` inside the repository to make
 sure all of your code is properly formatted. For Nix code, please use Alejandra.