Skip to content

Commit aeaf8c7

Browse files
committed
📝 Update README with refined documentation
Remove deprecated glow mode references and streamline content - Remove glow mode badge from header badges section - Remove glow_mode configuration option from default setup example - Remove entire "Glow Mode" section with toggle commands and setup - Update extras description to focus on environment extension - Clarify Git configuration description for conventional commits - Add VSCode theme installation instructions with VSIX package - Include system info theme setup with Macchina configuration - Add comprehensive commands table with all available operations - Expand "What's Included" section with detailed tool descriptions - Maintain all existing functionality while removing obsolete features
1 parent 1461363 commit aeaf8c7

File tree

1 file changed

+25
-23
lines changed

1 file changed

+25
-23
lines changed

README.md

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212

1313
[![Plugins](https://img.shields.io/badge/40+%20Plugins-Supported-bd93f9?style=for-the-badge&logo=puzzle-piece&logoColor=white)](https://github.com/hyperb1iss/silkcircuit-nvim#-plugin-support)
1414
[![Variants](https://img.shields.io/badge/4%20Variants-Neon%20|%20Vibrant%20|%20Soft%20|%20Glow-ffb86c?style=for-the-badge&logo=swatchbook&logoColor=white)](https://github.com/hyperb1iss/silkcircuit-nvim#-theme-variants)
15-
[![Glow Mode](https://img.shields.io/badge/Glow%20Mode-⚡-ff79c6?style=for-the-badge&logo=bolt&logoColor=white)](https://github.com/hyperb1iss/silkcircuit-nvim#-glow-mode)
1615

1716
🌌 _Pure electric energy with vibrant purples, blazing pinks, and neon accents_ 🎆
1817

@@ -35,7 +34,6 @@ SilkCircuit pumps maximum visual voltage through your Neovim. Electric purples
3534
- 👁️ **WCAG AA Compliant** — Validated contrast ratios for extended coding sessions
3635
- 🎛️ **Theme Variants** — Neon (100%), Vibrant (85%), Soft (70%), and Glow (ultra-dark) modes
3736
- 🔮 **40+ Plugin Integrations** — Auto-detected support for your entire toolchain
38-
- 🌟 **Glow Mode** — Enhanced highlights for maximum visibility
3937
- 💾 **Persistent Preferences** — Settings survive across sessions
4038

4139
## 💫 Installation
@@ -103,7 +101,6 @@ require("silkcircuit").setup({
103101
terminal_colors = true, -- Configure terminal colors
104102
dim_inactive = false, -- Dim inactive windows
105103
variant = "neon", -- Theme variant: "neon" | "vibrant" | "soft" | "glow"
106-
glow_mode = false, -- Enable glow mode
107104

108105
styles = {
109106
comments = { italic = true },
@@ -142,20 +139,6 @@ require("silkcircuit").setup({
142139
:SilkCircuit glow -- Ultra-dark backgrounds with pure neon colors
143140
```
144141

145-
### ✨ Glow Mode
146-
147-
Enhanced highlights for maximum visibility:
148-
149-
```lua
150-
-- Toggle glow mode
151-
:SilkCircuitGlow
152-
153-
-- Or in setup
154-
require("silkcircuit").setup({
155-
glow_mode = true,
156-
})
157-
```
158-
159142
### 🌌 Transparent Background
160143

161144
For a sleek, transparent look:
@@ -225,7 +208,7 @@ All integrations activate automatically when plugins are detected.
225208

226209
## 🌃 Complete Environment Setup
227210

228-
SilkCircuit includes extensive extras for a fully integrated neon development experience:
211+
SilkCircuit extends beyond Neovim with matching themes for your entire development environment:
229212

230213
### 🎯 Quick Setup
231214

@@ -234,24 +217,33 @@ SilkCircuit includes extensive extras for a fully integrated neon development ex
234217
git clone https://github.com/hyperb1iss/silkcircuit-nvim.git
235218
cd silkcircuit-nvim
236219

237-
# Electric git colors
220+
# Electric git colors with conventional commit support
238221
cat extras/gitconfig >> ~/.gitconfig
239222

240223
# Terminal themes (choose your terminal)
241224
cp extras/kitty.conf ~/.config/kitty/themes/silkcircuit.conf
242225
cp extras/alacritty.yml ~/.config/alacritty/themes/silkcircuit.yml
243226
cp extras/warp.yaml ~/.warp/themes/silkcircuit.yaml
244227

228+
# VSCode theme (all variants included)
229+
cd extras/vscode && npx @vscode/vsce package
230+
# Install the generated .vsix file in VSCode/Cursor
231+
232+
# System info theme
233+
cp extras/macchina/silkcircuit.toml ~/.config/macchina/themes/
234+
245235
# AstroNvim integration
246236
cp -r extras/astronvim/* ~/.config/nvim/lua/
247237
```
248238

249239
### 🚀 What's Included
250240

251-
- **⚡ Git configuration** - Electric colors for commits, branches, and diffs
252-
- **🖥️ Terminal themes** - Alacritty, Kitty, Warp, Windows Terminal
253-
- **🚀 AstroNvim integration** - Complete setup with enhanced components
254-
- **🎨 Tool configs** - FZF, Lualine, and more
241+
- **🎨 VSCode Themes** - All 4 variants (Neon, Vibrant, Soft, Glow) for VSCode/Cursor
242+
- **⚡ Git Configuration** - Electric colors with conventional commit highlighting
243+
- **🖥️ Terminal Themes** - Alacritty, Kitty, Warp, Windows Terminal, iTerm2
244+
- **🚀 AstroNvim Integration** - Complete setup with enhanced components
245+
- **📊 System Tools** - Macchina theme for system info display
246+
- **🎨 Tool Configs** - FZF, Lualine, and more
255247

256248
See [extras/README.md](extras/README.md) for detailed setup instructions.
257249

@@ -294,6 +286,16 @@ See [extras/README.md](extras/README.md) for detailed setup instructions.
294286
- 📬 Check [Issues](https://github.com/hyperb1iss/silkcircuit-nvim/issues)
295287
- 📝 Include config and error messages
296288

289+
## 🎮 Commands
290+
291+
| Command | Description |
292+
|---------|-------------|
293+
| `:SilkCircuit {variant}` | Switch theme variant (neon/vibrant/soft/glow) |
294+
| `:SilkCircuitContrast` | Check WCAG contrast compliance |
295+
| `:SilkCircuitCompile` | Compile theme for performance |
296+
| `:SilkCircuitIntegrations` | Show detected plugin integrations |
297+
| `:checkhealth silkcircuit` | Run health check diagnostics |
298+
297299
## 💖 Contributing
298300

299301
Contributions welcome! Submit issues and pull requests.

0 commit comments

Comments
 (0)