Skip to content

Commit f252570

Browse files
committed
docs: tidy quick start formatting
1 parent 5fd6186 commit f252570

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,22 +26,22 @@
2626

2727
## Quick Start
2828

29-
**Install via Homebrew:**
29+
**Install via Homebrew**
3030

3131
```bash
3232
brew install mole
3333
```
3434

35-
**Or via script:**
35+
**Or via script**
3636

3737
```bash
3838
# Optional args: -s latest for main branch code, -s 1.17.0 for specific version
3939
curl -fsSL https://raw.githubusercontent.com/tw93/mole/main/install.sh | bash
4040
```
4141

42-
**Windows:** Mole is built for macOS. An experimental Windows version is available in the [windows branch](https://github.com/tw93/Mole/tree/windows) for early adopters.
42+
> Note: Mole is built for macOS. An experimental Windows version is available in the [windows branch](https://github.com/tw93/Mole/tree/windows) for early adopters.
4343
44-
**Run:**
44+
**Run**
4545

4646
```bash
4747
mo # Interactive menu
@@ -60,13 +60,16 @@ mo update --nightly # Update to latest unreleased main build, script in
6060
mo remove # Remove Mole from system
6161
mo --help # Show help
6262
mo --version # Show installed version
63+
```
64+
65+
**Preview safely**
6366

64-
# Safe preview before applying changes
67+
```bash
6568
mo clean --dry-run
6669
mo uninstall --dry-run
6770
mo purge --dry-run
6871

69-
# --dry-run also works with: optimize, installer, remove, completion, touchid enable
72+
# Also works with: optimize, installer, remove, completion, touchid enable
7073
mo clean --dry-run --debug # Preview + detailed logs
7174
mo optimize --whitelist # Manage protected optimization rules
7275
mo clean --whitelist # Manage protected caches
@@ -160,7 +163,7 @@ Use `mo optimize --whitelist` to exclude specific optimizations.
160163

161164
### Disk Space Analyzer
162165

163-
By default, Mole skips external drives under `/Volumes` for faster startup. To inspect them, run `mo analyze /Volumes` or a specific mount path.
166+
> Note: By default, Mole skips external drives under `/Volumes` for faster startup. To inspect them, run `mo analyze /Volumes` or a specific mount path.
164167
165168
```bash
166169
$ mo analyze
@@ -226,10 +229,10 @@ Select Categories to Clean - 18.5GB (8 selected)
226229
● backend-service 2.5GB | node_modules
227230
```
228231

229-
> We recommend installing `fd` on macOS.
232+
> Note: We recommend installing `fd` on macOS.
230233
> `brew install fd`
231234
232-
> **Use with caution:** This permanently deletes selected artifacts. Review carefully before confirming. Projects newer than 7 days are marked and unselected by default.
235+
> Safety: This permanently deletes selected artifacts. Review carefully before confirming. Projects newer than 7 days are marked and unselected by default.
233236
234237
<details>
235238
<summary><strong>Custom Scan Paths</strong></summary>

0 commit comments

Comments
 (0)