Skip to content

Commit

Permalink
Update README (#34)
Browse files Browse the repository at this point in the history
* Update README

* Update README

* Update README

* Update README
  • Loading branch information
robenkleene authored Dec 25, 2023
1 parent c714836 commit 3e9bb82
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Rep Grep

`rep` is a command-line utility that takes [`grep`](https://en.wikipedia.org/wiki/Grep)-formatted lines via standard input, and performs a find-and-replace on them. By default, it outputs a [`diff`](https://en.wikipedia.org/wiki/Diff)-preview of the changes to standard output, and it can write the changes to the files in place with a flag.
`rep` is a command-line utility that takes [`grep`](https://en.wikipedia.org/wiki/Grep)-formatted lines via standard input, and performs a find-and-replace on them. By default, it outputs a [`diff`](https://en.wikipedia.org/wiki/Diff)-preview of the changes to standard output, and with a flag it can write the changes to the files in place.

[![Find & replace with `rep`](rep.gif)](https://www.youtube.com/embed/QIOKKTnC9-I)

Expand All @@ -12,7 +12,7 @@ Output a diff to standard output replacing `foo` with `bar`:
grep -n foo *` | rep foo bar
```

Write the changes to the files in place:
Add the `-w` flag to write the changes to the files in place:

```
grep -n foo *` | rep foo bar -w
Expand All @@ -22,7 +22,7 @@ The `-n` (`--line-number`) option is required so that `grep` outputs the line nu

## Help

`grep --help` (or `grep -h`) will list help for all the command-line flags.
`rep -h` (or `rep --help`) will list help for all the command-line flags.

## Acknowledgements

Expand Down

0 comments on commit 3e9bb82

Please sign in to comment.