Skip to content

Commit d0ae9b0

Browse files
committed
docs!: document v2.0 breaking changes and light theme migration
Add comprehensive breaking changes section to README documenting: - New dual-mode theme system with 5 light variants per style - Deprecated standalone light themes (dawn, dawnlight, day, dusk, dust) - Migration path from deprecated themes to night_light_* variants - Clarification that short theme names auto-expand to dark variants BREAKING CHANGE: Standalone light themes deprecated in favor of dual-mode system. Users must migrate to new night_light_1 through night_light_5 variants.
1 parent d45cec9 commit d0ae9b0

File tree

1 file changed

+49
-3
lines changed

1 file changed

+49
-3
lines changed

README.md

Lines changed: 49 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,52 @@ Oasis provides a fully styled status line with a robust dynamic mode indicator f
6161

6262
Choose from 13 distinct desert-inspired base styles, each with its own personality and color palette. Dual-mode themes now ship with one dark plus five fine-grained light variants.
6363

64+
<details>
65+
<summary>✨ What's New / 🚨 Breaking Changes</summary>
66+
<br/>
67+
<!-- whats-new:start -->
68+
69+
<details>
70+
<summary>🚨 v2.0: Dual Style Themes / Deprecated Themes</summary>
71+
<!-- v4:start -->
72+
<h3>✨ Dual Style Themes</h3>
73+
Each style now has <strong>5 light theme variants</strong>.
74+
<ul>
75+
<li>Check out the <a href="#%EF%B8%8F-light-styles">new light theme screenshots</a>.</li>
76+
</ul>
77+
<h3>🚨 BREAKING CHANGE: Deprecated Light Theme Migration</h3>
78+
The following standalone <strong>light themes have been deprecated</strong> in favor of the dual-mode system:
79+
<table>
80+
<tr>
81+
<td>Dawn</td>
82+
<td>Replaced with <code>night_light_1</code></td>
83+
</tr>
84+
<tr>
85+
<td>Dawnlight</td>
86+
<td>Replaced with <code>night_light_2</code></td>
87+
</tr>
88+
<tr>
89+
<td>Day</td>
90+
<td>Replaced with <code>night_light_3</code></td>
91+
</tr>
92+
<tr>
93+
<td>Dusk</td>
94+
<td>Replaced with <code>night_light_4</code></td>
95+
</tr>
96+
<tr>
97+
<td>Dust</td>
98+
<td>Replaced with <code>night_light_5</code></td>
99+
</tr>
100+
</table>
101+
<blockquote>
102+
<strong>Note:</strong> The migration table above shows direct replacements. All deprecated themes were based on the <code>night</code> style family.
103+
</blockquote>
104+
<br/>
105+
<!-- v4:end -->
106+
</details>
107+
<!-- whats-new:end -->
108+
</details>
109+
64110
## 🌙 Dark Styles
65111

66112
Click any card below to view the full preview and syntax sample. [↓ Or click here to view all full previews](#view-all-theme-styles)
@@ -218,7 +264,7 @@ The status line is inspired from **lualine** in Neovim. It includes:
218264

219265
- **Dual-mode themes**: `abyss`, `cactus`, `canyon`, `desert`, `dune`, `lagoon`, `mirage`, `midnight`, `night`, `rose`, `sol`, `starlight`, `twilight`
220266
- Variants: `_dark` and `_light_1``_light_5`
221-
- Short names auto-expand: setting `set -g @oasis_flavor "lagoon"` loads `lagoon_dark`
267+
- Short names auto-expand to dark: setting `set -g @oasis_flavor "lagoon"` loads `lagoon_dark`
222268

223269
Examples:
224270

@@ -396,7 +442,7 @@ set -g @oasis_flavor "night" # resolves to night_dark
396442
<a href="#light-previews">↑ Back to Light Styles</a>
397443
</p>
398444

399-
<a id="starlight-3-light"></a>
445+
<a id="starlight-light"></a>
400446
**Starlight (Light)**
401447

402448
![starlight-light-3-dashboard](./assets/screenshots/starlight-light-3-dashboard.png)
@@ -468,7 +514,7 @@ set -g @oasis_flavor "night" # resolves to night_dark
468514
<a href="#light-previews">↑ Back to Light Styles</a>
469515
</p>
470516

471-
<a id="twilight-3-light"></a>
517+
<a id="twilight-light"></a>
472518
**Twilight (Light)**
473519

474520
![twilight-light-3-dashboard](./assets/screenshots/twilight-light-3-dashboard.png)

0 commit comments

Comments
 (0)