README suggestions

[gurgeous]

Hey there, thanks for creating rep-grep. This thing is great! My company has a similar tool ironically named greprep, lovingly handed down from startup to startup...

We use rep like so:

1. Run rg -n something > /tmp/rep.txt
2. Edit rep.txt in your favorite editor, ideally with multiple cursors.
3. Apply withcat /tmp/rep.txt | rep -w

Funnily enough, we had a heck of a time discovering rep and figuring out that it worked for us. Might I suggest some improvements to the README that might make it easier to discover for people like me? Some examples off the top of my head:

• showcase the use case I outlined above
• mention similar tools like the venerable wgrep. those keywords would help!
• show how this is different from other popular tools like ruplacer or fastmod or rg -r

I'd be happy to put together a PR if that would be helpful.

[robenkleene]

Hi @gurgeous yeah absolutely! That we don't document the usage pattern you metioned is an embarrassing omission. I've actually started working on this on the improve-docs branch, but I'm also updating and improving the man page and help flag generation infrastructure in the process so it's taking awhile.

Merging a PR just focused on updating the README would be a helpful thing to do short term! If you want to take a crack at a PR that would be helpful.

Lets keep each PR focused, e.g., one PR to add the example, another comparing to other tools, etc... this will make them easier to review and merge.

I think all three you mentioned are good ideas. (Note that I do already mention wgrep, in the README assuming you mean the Emacs mode).

[gurgeous]

Sure, I'll give it a whirl when I get a minute. Happy to help!

[robenkleene]

I suddenly remembered I'd actually already written some of this out on the improve-docs branch, so I realized I should go ahead port the part updating the README over, so I've gone ahead and merged that. Let me know what you think, and please submit a PR if you have ideas for improvements. I didn't cover this point you mentioned at all: "show how this is different from other popular tools like ruplacer or fastmod or rg -r". And I'm not familiar enough with those tools to write that part myself.

[gurgeous]

Neat! I'll check it out and maybe suggest some edits.

One idea - have you tried vhs? I used it to make the demo video for one of my projects and it came out great.

[gurgeous]

Here's an example of changes you might want to make to the top section. I added a simple logo, a tagline, a wgrep-style example....

https://github.com/gurgeous/rep-grep/tree/readme-updates

LMK if you want a PR or more stuff like this. These are just ideas.

[robenkleene]

Looks good! There are a few edits I know I'd make but if you send this as a PR I'll merge it. The logo is great thank you! Do you have an editable asset for it? E.g., SVG, or even Illustrator or other proprietary formats? If so, we can include that in the PR in case we want to edit it later (I also have a sibling tool called ren for renaming files and I'd make a variation use this logo for that too). Thanks!

[gurgeous]

I did it in figma and I can certainly export all the formats, or share the figma file with you. Font is Baloo.

I'll put together a PR when I get a chance, hopefully today