Skip to content

Commit

Permalink
Clarify readme and naming
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasschafer committed Nov 10, 2024
1 parent 0d54aef commit e94c2c3
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,18 @@

Scout is an interactive find-and-replace terminal UI app.

Search with either a fixed string or a regular expression, enter a replacement, and interactively toggle which instances you want to replace. If the instance you're attempting to replace has changed since the search was performed, e.g. if you've switched branches and that line no longer exists, that particular replacement won't occur: you'll see all such cases at the end.
Search with either a fixed string or a regular expression, enter a replacement, and interactively toggle which instances you want to replace. You can also specify a regex pattern for the file paths you want to search in.

If the instance you're attempting to replace has changed since the search was performed, e.g. if you've switched branches and that line no longer exists, that particular replacement won't occur: you'll see all such cases at the end.

![Scout preview](media/preview.gif)

To install, run
## Installation

Install with

```sh
cargo install --path .
```

then run `scout`.
2 changes: 1 addition & 1 deletion src/ui.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ impl FieldName {
FieldName::Search => "Search text",
FieldName::Replace => "Replace text",
FieldName::FixedStrings => "Fixed strings",
FieldName::FilenamePattern => "Filename pattern",
FieldName::FilenamePattern => "Filename pattern (regex)",
}
}
}
Expand Down

0 comments on commit e94c2c3

Please sign in to comment.