gdx 0.3.0 → 0.4.0

package/README.md

@@ -178,18 +178,36 @@ install dependencies using detected package managers (currently supports npm, pn
 if configured (see `parallel.init` config for options),
 getting the fork ready for work in no time.
 
-### 5. Advanced Stash Management
+### 5. Git Output for Human (Experimental)
+
+Admit it, Git's default output isn't exactly designed for readability.
+`gdx` enhances the output of some commands with better formatting to make it more enjoyable and less "git" to read.
+
+Currently, we only support enhanced formatting for `gdx diff` and `gdx show`,
+but more commands will be added in the future. (feel free to request what commands you'd like to see enhanced!)
+
+#### Example: `gdx diff`
+
+![diff example](https://github.com/Type-Delta/gdx/raw/main/resources/images/gdx-diff-enhance.png)
+
+> [!NOTE]
+> The enhanced output is only enabled when the output is TTY (i.e., in the terminal) plus other conditions based on the command (e.g., `diff` must be run without `--name-only`).
+> If you pipe the output to a file or another command, it will fall back to the standard Git output.
+>
+> If you want to disable the enhanced output altogether, you can set `enhancedOutput` to `false` in the config.
+
+### 6. Advanced Stash Management
 
 Git stash is great until you need to clean it up.
 
 ```bash
 gdx sta l           # git stash list
-gdx sta d 2..6      # Drops stashes 2 through 6.
+gdx sta drop 2..6   # Drops stashes 2 through 6.
                     # (Drops high->low to prevent index shifting)
-gdx sta d pardon    # Restores the last dropped stash.
+gdx stash d pardon  # Restores the last dropped stash.
 ```
 
-### 6. AI-Powered Commits
+### 7. Commits Message Generation
 
 Struggling to come up with a commit message? Let `gdx` do it for you.
 
@@ -198,11 +216,11 @@ gdx commit auto   # Generates a commit message based on staged changes, then com
 # or
 # Generates a commit message based on staged changes, but does not commit them.
 # `--copy` also copies the message to clipboard.
-gdx commit auto --no-commit --copy
+gdx cmi auto --no-commit --copy
 # You can also configure which LLM to use with `gdx-config`
 ```
 
-### 7. Fun & Analytics
+### 8. Fun & Analytics
 
 Tools to help you feel productive without leaving the terminal.
 
@@ -210,6 +228,10 @@ Tools to help you feel productive without leaving the terminal.
 - **`gdx graph`**: Renders a GitHub-style contribution heatmap in your terminal using TrueColor.
 - **`gdx nocap`**: Uses AI to roast your latest commit message.
 
+#### Example: `gdx stats`
+
+![stats example](https://github.com/Type-Delta/gdx/raw/main/resources/images/gdx-stats.png)
+
 ## Command Reference
 
 | Command      | Expansion / Function                                               |
@@ -220,6 +242,8 @@ Tools to help you feel productive without leaving the terminal.
 | `br`, `bra`  | `git branch`                                                       |
 | `cmi`, `com` | `git commit` (Try `gdx cmi auto` for AI messages!)                 |
 | `res`        | `git reset` (supports `res ~3`, `res -h` expansion)                |
+| `dif`        | `git diff` (supports `dif ~3`, `dif origin ~2` expansion)          |
+| `sho`        | `git show` (supports `sho ~3`, `sho origin ~2` expansion)          |
 | `sta`, `st`  | `git stash`                                                        |
 | `lint`       | Run pre-push checks (spelling, secrets, etc.)                      |
 | `gdx-config` | Manage gdx configuration                                           |