Skip to content

Commit 266ec1a

Browse files
committed
📝 docs(docs,readme): update documents and assets
1 parent 7bef388 commit 266ec1a

5 files changed

Lines changed: 30 additions & 19 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
/>
6060
</p>
6161

62-
**Forgot what you worked on yesterday?**
62+
**Forgot what you worked today?**
6363

6464
**gohome** automates your daily status reporting by recursively scanning your workspace to find git repositories. It aggregates commit logs from multiple projects instantly and formats them into beautiful, ready-to-share reports.
6565

@@ -359,10 +359,10 @@ gohome
359359
gohome
360360
```
361361

362-
**2️⃣ Look back 3 days**
362+
**2️⃣ Look back 1 week**
363363

364364
```bash
365-
gohome -d 3
365+
gohome -w 1
366366
```
367367

368368
**3️⃣ Generate a Table Report**
@@ -613,23 +613,23 @@ gohome config reset
613613
| Flag | Alias | Description | Default |
614614
| ---------------- | ----- | ----------------------------------------------------- | ----------- |
615615
| `--hours` | `-H` | Number of hours to look back | 0 |
616-
| `--today` | | Report from midnight to now | false |
616+
| `--today` | `-T` | Report from midnight to now | false |
617617
| `--days` | `-d` | Number of days to look back | 1 |
618618
| `--weeks` | `-w` | Number of weeks to look back | 0 |
619619
| `--months` | `-m` | Number of months to look back | 0 |
620620
| `--years` | `-y` | Number of years to look back | 0 |
621621
| `--path` | `-p` | Root path to scan for repositories | `.` |
622-
| `--max-depth` | | Maximum depth to scan for repositories | 2 |
622+
| `--max-depth` | `-m` | Maximum depth to scan for repositories | 2 |
623623
| `--author` | `-a` | Git author name (auto-detected) | System User |
624624
| `--format` | `-f` | Output format: `text`, `table` | `text` |
625625
| `--preset` | `-s` | Table style: `normal`, `markdown` | `normal` |
626-
| `--all-branches` | `-b` | Include commits from all local branches | false |
627-
| `--branch` | | Filter commits by specific branch | (current) |
626+
| `--all-branches` | `-A` | Include commits from all local branches | false |
627+
| `--branch` | `-b` | Filter commits by specific branch | (current) |
628628
| `--copy` | `-cp` | Copy output to clipboard | false |
629629
| `--icon` | `-i` | Show icon column (table format only) | false |
630630
| `--scope` | `-c` | Show scope column (table format only) | false |
631631
| `--task` | `-t` | Add custom task (repeatable) | [] |
632-
| `--save` | | Save current flags as default config | false |
632+
| `--save` | `-S` | Save current flags as default config | false |
633633
| `--version` | `-v` | Show version information | |
634634
| `--help` | `-h` | Show help message | |
635635

docs/RELEASE_GUIDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,7 @@ release:
400400
401401
#### Linux
402402
```bash
403-
curl -sSL https://raw.githubusercontent.com/anIcedAntFA/gohome/main/install.sh | bash
403+
curl -sS https://get.ngockhoi96.dev/gohome | sh
404404
```
405405
406406
#### Go Install

docs/demos/config.gif

Lines changed: 2 additions & 2 deletions
Loading

docs/demos/quickstart.gif

Lines changed: 2 additions & 2 deletions
Loading

docs/demos/quickstart.tape

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,18 +54,29 @@ Sleep 500ms
5454
Enter
5555
Sleep 4s
5656

57-
# Show with icons and scope
58-
Type "# With emojis and commit scopes"
59-
Enter
60-
Type "gohome --icon --scope"
57+
# Save configuration
58+
Type "# Save your preferences"
59+
Enter
60+
Type "gohome --today --icon --scope --save"
6161
Sleep 500ms
6262
Enter
63-
Sleep 4s
63+
Sleep 3s
64+
65+
# Copy to clipboard
66+
Type "# Copy report to clipboard"
67+
Enter
68+
Type "gohome --copy"
69+
Sleep 500ms
70+
Enter
71+
Sleep 1s
72+
Type "# 📋 Report copied!"
73+
Enter
74+
Sleep 2s
6475

6576
# Final message
6677
Sleep 1s
6778
Type "# ✨ Try it yourself!"
6879
Enter
69-
Type "# curl -fsSL https://raw.githubusercontent.com/anIcedAntFA/gohome/main/scripts/install.sh | bash"
80+
Type "# curl -sS https://get.ngockhoi96.dev/gohome | sh"
7081
Enter
7182
Sleep 3s

0 commit comments

Comments
 (0)