Skip to content

Reorganize README examples: move glob patterns after write options#32

Merged
azu merged 3 commits intomainfrom
claude/add-dockerfile-pin-preview-JOVZ1
Apr 3, 2026
Merged

Reorganize README examples: move glob patterns after write options#32
azu merged 3 commits intomainfrom
claude/add-dockerfile-pin-preview-JOVZ1

Conversation

@azu
Copy link
Copy Markdown
Owner

@azu azu commented Apr 3, 2026

Summary

Reorganized the order of examples in the README documentation to improve logical flow and readability.

Changes

  • Moved glob pattern examples (--glob flag usage) to appear after the --write and --update options
  • This creates a more intuitive progression: basic usage → file-specific preview → write operations → advanced glob patterns
  • No functional changes to the tool itself; documentation reorganization only

Rationale

The new ordering presents features in a more natural learning progression, allowing users to understand basic operations before encountering more advanced pattern-matching capabilities.

https://claude.ai/code/session_0143hgHrsTAciTRVr17KzYj4

claude and others added 3 commits April 3, 2026 13:06
Reorganize the Usage > Run examples to follow a natural progression:
default (dry-run) → write → complex patterns (glob, ignore).

https: //claude.ai/code/session_0143hgHrsTAciTRVr17KzYj4
Co-authored-by: azu <azu@users.noreply.github.com>
Place the --write and --write --update examples immediately after
the basic dry-run example for a more natural flow:
run → write → file selection → glob → ignore.

https: //claude.ai/code/session_0143hgHrsTAciTRVr17KzYj4
Co-authored-by: azu <azu@users.noreply.github.com>
The --update flag is already explained in the dedicated
"Digest Updates" section below, so remove the duplicate
example from the quick Usage listing to avoid confusion.

https: //claude.ai/code/session_0143hgHrsTAciTRVr17KzYj4
Co-authored-by: azu <azu@users.noreply.github.com>
@azu azu marked this pull request as ready for review April 3, 2026 13:08
@azu azu added the Type: Documentation Documentation only changes label Apr 3, 2026
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 1 additional finding.

Open in Devin Review

@azu azu merged commit 0754768 into main Apr 3, 2026
3 checks passed
@azu azu deleted the claude/add-dockerfile-pin-preview-JOVZ1 branch April 3, 2026 13:10
@github-actions github-actions Bot mentioned this pull request Apr 3, 2026
azu pushed a commit that referenced this pull request Apr 3, 2026
<!-- Release notes generated using configuration in .github/release.yml
at main -->

## What's Changed

### Features

* feat: Add glob pattern matching for --ignore-images and config file
support by @azu in #30

### Documentation
* Reorganize README examples: move glob patterns after write options by
@azu in #32
* docs: Add docker-compose.yml and GitHub Actions examples to README by
@azu in #31


**Full Changelog**:
v1.1.0...v1.2.0

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Type: Documentation Documentation only changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants