Skip to content

Commit 6d131fb

Browse files
Simonf8Simonf8
authored
Update README.md (#110)
1 parent a1bac68 commit 6d131fb

File tree

1 file changed

+165
-24
lines changed

1 file changed

+165
-24
lines changed

‎README.md‎

Lines changed: 165 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,176 @@
1+
```diff
2+
╭─────────────────────────────────────────────────────────────╮
3+
│ │
4+
+ │ ██╗ ██╗██╗ ██╗██████╗ ███████╗ ██████╗██╗ ██╗│
5+
+ │ ██║ ██║╚██╗ ██╔╝██╔══██╗██╔════╝ ██╔════╝██║ ██║│
6+
+ │ ███████║ ╚████╔╝ ██║ ██║█████╗ █████╗██║ ██║ ██║│
7+
+ │ ██╔══██║ ╚██╔╝ ██║ ██║██╔══╝ ╚════╝██║ ██║ ██║│
8+
+ │ ██║ ██║ ██║ ██████╔╝███████╗ ╚██████╗███████╗██║│
9+
+ │ ╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚══════╝ ╚═════╝╚══════╝╚═╝│
10+
│ │
11+
- │ Terminal-powered HyDE configuration beast │
12+
╰─────────────────────────────────────────────────────────────╯
13+
```
14+
115
<div align="center">
2-
<br>
316

4-
![hyde_cli_banner](https://raw.githubusercontent.com/krhyme7/hyde-cli/master/Assets/hyde_cli_banner.png)
17+
### <span style="color: #00ff41; font-weight: bold;">QUICK ACCESS TERMINAL</span>
518

6-
<br>
7-
<a href="https://hydeproject.pages.dev/guides/cli/#installation"><kbd> <br> Installation <br> </kbd></a>&ensp;&ensp;
8-
<a href="https://raw.githubusercontent.com/HyDE-Project/Hyde-cli/master/USAGE.md"><kbd> <br> Usage <br> </kbd></a>&ensp;&ensp;
9-
<a href="https://hydeproject.pages.dev/reference/faqs/"><kbd> <br> FAQ <br> </kbd></a>&ensp;&ensp;
10-
<a href="#support"><kbd> <br> Support <br> </kbd></a>&ensp;&ensp;
11-
<a href="https://hydeproject.pages.dev/reference/roadmap/"><kbd> <br> Roadmap <br> </kbd></a>&ensp;&ensp;
12-
<a href="https://github.com/HyDE-Project/Hyde-cli/wiki"><kbd> <br> Wiki <br> </kbd></a>&ensp;&ensp;
13-
<a href="https://discord.gg/qWehcFJxPa"><kbd> <br> HyDE Discord <br> </kbd></a>
14-
<br><br><br>
19+
```diff
20+
+ ┌─[ NAVIGATION ]────────────────────────────────────────────────────┐
21+
+ │ │
22+
+ │ > install │ > usage │ > faq │ > support │
23+
+ │ > roadmap │ > wiki │ > discord │ > github │
24+
+ │ │
25+
+ └───────────────────────────────────────────────────────────────────┘
26+
```
1527

16-
Hyde-cli is a CLI tool for [HyDE](https://github.com/prasanthrangan/hyprdots).
17-
This repository contains scripts that, while may not be perfect, could provide a better way to manage your HyDE installation.
18-
For example, we have a functional TUI restore tool that follows `restore_cfg.lst`, power-saving options that could be useful for laptops, and much more!
28+
**<span style="color: #ff6b35;">[`INSTALL`](https://hydeproject.pages.dev/guides/cli/#installation)</span>** • **<span style="color: #ff6b35;">[`USAGE`](https://raw.githubusercontent.com/HyDE-Project/Hyde-cli/master/USAGE.md)</span>** • **<span style="color: #ff6b35;">[`FAQ`](https://hydeproject.pages.dev/reference/faqs/)</span>** • **<span style="color: #ff6b35;">[`SUPPORT`](#support)</span>** • **<span style="color: #ff6b35;">[`ROADMAP`](https://hydeproject.pages.dev/reference/roadmap/)</span>** • **<span style="color: #ff6b35;">[`WIKI`](https://github.com/HyDE-Project/Hyde-cli/wiki)</span>** • **<span style="color: #ff6b35;">[`DISCORD`](https://discord.gg/qWehcFJxPa)</span>**
1929

2030
</div>
2131

22-
> [!CAUTION]
23-
> While Hyde-cli is stable, it is important to note that these scripts do alter and *could* potentially mess up your system configuration.
24-
> We ask that you use this tool carefully and report any bugs you find.
32+
---
33+
34+
## <span style="color: #00ff41;">▸ SYSTEM BRIEFING</span>
35+
36+
```diff
37+
+ ╔══════════════════════════════════════════════════════════════════╗
38+
+ ║ DESIGNATION: Hyde-CLI ║
39+
+ ║ MISSION: Advanced HyDE configuration management ║
40+
+ ║ STATUS: Active Development ║
41+
! ║ THREAT LEVEL: Minimal (with proper usage) ║
42+
+ ╚══════════════════════════════════════════════════════════════════╝
43+
```
44+
45+
<span style="color: #ffffff;">Hyde-cli is not your average configuration tool. It's a surgical instrument for</span> <span style="color: #00ff41;">[HyDE](https://github.com/prasanthrangan/hyprdots)</span> <span style="color: #ffffff;">power users who demand precision, speed, and reliability. Built by terminal enthusiasts, for terminal enthusiasts.</span>
46+
47+
### <span style="color: #00ff41;">▸ CORE CAPABILITIES</span>
48+
49+
```diff
50+
+ ┌─[ CONFIGURATION WARFARE ]─────────────────────────────────────────┐
51+
+ │ │
52+
+ │ ◆ TUI Restore Engine │ Smart config rollback system │
53+
+ │ ◆ Backup Orchestration │ Zero-loss configuration management │
54+
+ │ ◆ Sync Protocol │ Multi-machine configuration sync │
55+
+ │ │
56+
+ ├─[ POWER MANAGEMENT ]──────────────────────────────────────────────┤
57+
+ │ │
58+
+ │ ◆ Laptop Optimization │ Battery-focused performance tuning │
59+
+ │ ◆ Resource Allocation │ Dynamic system resource management │
60+
+ │ ◆ Thermal Control │ Intelligent cooling strategies │
61+
+ │ │
62+
+ ├─[ DEVELOPER ARSENAL ]─────────────────────────────────────────────┤
63+
+ │ │
64+
+ │ ◆ Command Interface │ Intuitive CLI with smart completion │
65+
+ │ ◆ Debug Framework │ Comprehensive logging and tracing │
66+
+ │ ◆ Error Recovery │ Automatic failsafe mechanisms │
67+
+ │ │
68+
+ └───────────────────────────────────────────────────────────────────┘
69+
```
70+
71+
---
72+
73+
## <span style="color: #00ff41;">▸ DEPLOYMENT PROTOCOL</span>
74+
75+
```bash
76+
# [ RAPID DEPLOYMENT ]
77+
curl -fsSL https://hydeproject.pages.dev/install | bash
78+
79+
# [ VERIFY INSTALLATION ]
80+
hyde --version && echo "▸ DEPLOYMENT SUCCESSFUL"
81+
82+
# [ SYSTEM CHECK ]
83+
hyde doctor
84+
```
85+
86+
### <span style="color: #00ff41;">▸ SYSTEM REQUIREMENTS</span>
87+
88+
```diff
89+
+ ╭─[ MINIMUM SPECIFICATIONS ]─────────────────────────────────────╮
90+
+ │ │
91+
+ │ PLATFORM │ Linux (Arch-based recommended) │
92+
+ │ SHELL │ Bash 4.0+ / Zsh │
93+
+ │ RUNTIME │ Git, curl, base-devel │
94+
+ │ TARGET │ HyDE v2.0+ │
95+
+ │ │
96+
+ ╰────────────────────────────────────────────────────────────────╯
97+
```
98+
99+
---
100+
101+
## <span style="color: #ff0000;">⚠OPERATIONAL WARNING</span>
102+
103+
```diff
104+
! ┌─[ CAUTION: SYSTEM MODIFICATION DETECTED ]─────────────────────────┐
105+
! │ │
106+
! │ This tool directly interfaces with system configurations. │
107+
! │ While battle-tested, configuration corruption is possible. │
108+
! │ │
109+
! │ RECOMMENDED: Create system snapshots before engagement. │
110+
! │ REQUIRED: Report anomalies via issue tracking system. │
111+
! │ │
112+
! └───────────────────────────────────────────────────────────────────┘
113+
```
25114

115+
---
26116

27-
## Support
117+
## <span style="color: #00ff41;">▸ SUPPORT OPERATIONS</span>
28118

29-
If you would like to support this project, but don't know how, here are some ways:
119+
### <span style="color: #ff6b35;">『 CONTRIBUTION VECTORS 』</span>
30120

31-
- Submit PRs. Even if it's formatting improvements or fixing spelling mistakes, they are all appreciated!
32-
- Report issues. Major or minor, doesn't matter, please report any you find.
33-
- I don't really know what the use of the stars is, but feel free to leave one!
34-
35-
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/A0A3TECUZ)
121+
```diff
122+
+ ┌─[ CODE OPERATIONS ]────────────────────────────────────────────────┐
123+
+ │ • Pull Request Deployment │
124+
+ │ • Code Review & Testing │
125+
+ │ • Documentation Enhancement │
126+
+ └────────────────────────────────────────────────────────────────────┘
127+
128+
+ ┌─[ INTELLIGENCE GATHERING ]────────────────────────────────────────┐
129+
+ │ • Bug Report Filing │
130+
+ │ • Feature Request Submission │
131+
+ │ • Usage Pattern Analysis │
132+
+ └────────────────────────────────────────────────────────────────────┘
133+
134+
+ ┌─[ COMMUNITY ENGAGEMENT ]──────────────────────────────────────────┐
135+
+ │ • Repository Recognition (★) │
136+
+ │ • Knowledge Transfer │
137+
+ │ • Feedback Loop Participation │
138+
+ └────────────────────────────────────────────────────────────────────┘
139+
```
140+
141+
142+
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/A0A3TECUZ)
143+
144+
---
145+
146+
## <span style="color: #00ff41;">▸ COMMUNICATION CHANNELS</span>
147+
148+
```diff
149+
+ ╔═[ COMMUNITY NETWORK ]═══════════════════════════════════════════╗
150+
+ ║ ║
151+
+ ║ DISCORD │ Real-time tactical communication ║
152+
+ ║ WIKI │ Comprehensive knowledge database ║
153+
+ ║ GITHUB │ Issue tracking and development coordination ║
154+
+ ║ ║
155+
+ ╚═════════════════════════════════════════════════════════════════╝
156+
```
157+
158+
**<span style="color: #ff6b35;">CHANNELS:</span>** <span style="color: #00ff41;">[`Discord Server`](https://discord.gg/qWehcFJxPa)</span> • <span style="color: #00ff41;">[`Wiki Database`](https://github.com/HyDE-Project/Hyde-cli/wiki)</span> • <span style="color: #00ff41;">[`Discussion Board`](https://github.com/HyDE-Project/Hyde-cli/discussions)</span>
159+
160+
---
161+
162+
<div align="center">
163+
164+
```diff
165+
+ ╭─────────────────────────────────────────────────────────────╮
166+
+ │ │
167+
+ │ ENGINEERED FOR THE HyDE ECOSYSTEM │
168+
+ │ │
169+
+ │ [Documentation] • [Changelog] • [License] • [Issues] │
170+
+ │ │
171+
+ ╰─────────────────────────────────────────────────────────────╯
172+
```
173+
174+
**<span style="color: #ff6b35;">ACCESS POINTS:</span>** <span style="color: #00ff41;">[`DOCS`](https://hydeproject.pages.dev)</span> • <span style="color: #00ff41;">[`CHANGELOG`](CHANGELOG.md)</span> • <span style="color: #00ff41;">[`LICENSE`](LICENSE)</span> • <span style="color: #00ff41;">[`ISSUES`](https://github.com/HyDE-Project/Hyde-cli/issues)</span>
175+
176+
</div>

0 commit comments

Comments
 (0)