Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasschafer committed Nov 19, 2024
1 parent da1daea commit b19885f
Showing 1 changed file with 18 additions and 6 deletions.
24 changes: 18 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,22 @@ Scooter respects both `.gitignore` and `.ignore` files.

You can add capture groups to the search regex and use them in the replacement string: for instance, if you use `(\d) - (\w+)` for the search text and `($2) "$1"` as the replacement, then `9 - foo` would be replaced with `(foo) "9"`.

## Usage

Run

```sh
scooter
```

in a terminal to launch Scooter. By default the current directory is used to search and replace in, but you can pass in a directory as the first argument to override this behaviour:

```sh
scooter ../foo/bar`
```

You can then enter some text to search with and text to replace matches with, toggle on or off fixed strings, and enter a regex pattern that filenames must match. A more extensive set of keymappings will be shown at the bottom of the window: these vary slightly depending on the screen you're on.
## Installation
### Cargo
Expand All @@ -26,13 +42,13 @@ cargo install scooter
### Prebuilt binaries
You can download binaries from the releases page (note that you'll need to unzip after downloading):
You can download binaries from the [releases page](https://github.com/thomasschafer/scooter/releases/latest). After downloading, unzip the binary and move it to a directory in your `PATH`.
- **Linux**
- Intel/AMD: `*-x86_64-unknown-linux-musl.tar.gz`
- ARM64: `*-aarch64-unknown-linux-musl.tar.gz`
- **macOS**
- Apple Silicon: `*-aarch64-apple-darwin.tar.gz`
- Apple silicon: `*-aarch64-apple-darwin.tar.gz`
- Intel: `*-x86_64-apple-darwin.tar.gz`
- **Windows**
- `*-x86_64-pc-windows-msvc.zip`
Expand All @@ -47,10 +63,6 @@ cd scooter
cargo install --path .
```
## Usage

Run `scooter` in a terminal to launch Scooter. You can then enter some text to search with and text to replace matches with, toggle on or off fixed strings, and enter a regex pattern that filenames must match. A more extensive set of keymappings will be shown at the bottom of the window: these vary slightly depending on the screen you're on.

## Contributing
Contributions are very welcome! I'd be especially grateful for any contributions to add scooter to popular package managers. If you'd like to add a new feature, please create an issue first so we can discuss the idea, then create a PR with your changes.

0 comments on commit b19885f

Please sign in to comment.