From e94c2c323cc585385fcba50f6963519447367225 Mon Sep 17 00:00:00 2001 From: thomasschafer Date: Fri, 8 Nov 2024 23:02:58 +0000 Subject: [PATCH] Clarify readme and naming --- README.md | 10 ++++++++-- src/ui.rs | 2 +- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 17cff2e..ebd9b56 100644 --- a/README.md +++ b/README.md @@ -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`. diff --git a/src/ui.rs b/src/ui.rs index 410a052..c396095 100644 --- a/src/ui.rs +++ b/src/ui.rs @@ -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)", } } }