Skip to content

Commit 4bd08d7

Browse files
committed
docs: improve README branding and update config to PERFDECK_CONFIG
1 parent 400f2a8 commit 4bd08d7

3 files changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div align="center">
22

3-
# 📊 perfdeck
3+
# 📊 Perfdeck
44

55
**A modern, lightweight, and customizable TUI performance monitor for your terminal.**
66

@@ -16,9 +16,9 @@
1616

1717
---
1818

19-
## 💡 Why perfdeck?
19+
## 💡 Why Perfdeck?
2020

21-
Traditional performance monitors often overwhelm users with information or lack the flexibility to show exactly what you need. **perfdeck** solves this by providing:
21+
Traditional performance monitors often overwhelm users with information or lack the flexibility to show exactly what you need. **Perfdeck** solves this by providing:
2222

2323
- **Consolidation**: View output from multiple diagnostic tools (like `top`, `vmstat`, `netstat`) in one place.
2424
- **Focus**: A clean, tabbed interface lets you switch between different metrics without terminal clutter.
@@ -37,10 +37,10 @@ Traditional performance monitors often overwhelm users with information or lack
3737
## 📸 Screenshots
3838

3939
### Dark Mode (Default)
40-
![perfdeck Dark Mode](https://github.com/user-attachments/assets/7a94f63d-02ee-4992-b66d-9adf42a16603)
40+
![Perfdeck Dark Mode](https://github.com/user-attachments/assets/7a94f63d-02ee-4992-b66d-9adf42a16603)
4141

4242
### Light Mode
43-
![perfdeck Light Mode](https://github.com/user-attachments/assets/19025abf-63e0-49c3-b5a5-c5c07f62468b)
43+
![Perfdeck Light Mode](https://github.com/user-attachments/assets/19025abf-63e0-49c3-b5a5-c5c07f62468b)
4444

4545
## 🚀 Installation
4646

@@ -74,12 +74,12 @@ perfdeck
7474
| `j` / `k` (or ``/``) | Scroll through command output |
7575
| `t` | Toggle Light/Dark theme |
7676
| `v` | Display version information |
77-
| `q` / `Esc` / `Ctrl+C` | Exit perfdeck |
77+
| `q` / `Esc` / `Ctrl+C` | Exit Perfdeck |
7878

7979
## ⚙️ Configuration
8080

81-
perfdeck is designed to be personalized. It looks for `perfdeck.toml` in:
82-
1. `$PERFMON_CONFIG`
81+
Perfdeck is designed to be personalized. It looks for `perfdeck.toml` in:
82+
1. `$PERFDECK_CONFIG`
8383
2. `~/.config/perfdeck/config.toml`
8484
3. Current working directory
8585

internal/config/config.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,13 +92,13 @@ func loadFromConfig() (Config, bool) {
9292

9393
func configPaths() []string {
9494
var paths []string
95-
if env := strings.TrimSpace(os.Getenv("PERFMON_CONFIG")); env != "" {
95+
if env := strings.TrimSpace(os.Getenv("PERFDECK_CONFIG")); env != "" {
9696
paths = append(paths, env)
9797
}
9898
if cfgDir, err := os.UserConfigDir(); err == nil {
99-
paths = append(paths, filepath.Join(cfgDir, "perfmon", "config.toml"))
99+
paths = append(paths, filepath.Join(cfgDir, "perfdeck", "config.toml"))
100100
}
101-
paths = append(paths, "perfmon.toml")
101+
paths = append(paths, "perfdeck.toml")
102102
return paths
103103
}
104104

internal/config/config_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ refresh_interval = "1s"
4343

4444
func TestLoadTabsFromConfig(t *testing.T) {
4545
dir := t.TempDir()
46-
path := filepath.Join(dir, "perfmon.toml")
46+
path := filepath.Join(dir, "perfdeck.toml")
4747
err := os.WriteFile(path, []byte(`
4848
global_refresh_interval = "2s"
4949
[[tab]]
@@ -54,7 +54,7 @@ cmd = ["vmstat"]
5454
t.Fatalf("write: %v", err)
5555
}
5656

57-
t.Setenv("PERFMON_CONFIG", path)
57+
t.Setenv("PERFDECK_CONFIG", path)
5858
_, tabs := Load() // Load now returns (Config, []Tab)
5959

6060
if len(tabs) != 1 {

0 commit comments

Comments
 (0)