find readme

find-readme - Find README.md under path.

DON'T USE THIS

This App is a sample implementation for using path/filepath/Walk.
Use the_silver_searcher is more faster and powerful 😌

$ function find-readme { ag -l "" ${1:?} | ag -i 'readme.md'; }
$ find-readme ~/go

see benchmark

Usage

$ find-readme [global options] command [command options] path ...

COMMANDS:

help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:

--ignore name, -i name  Directory name to ignore.
--help, -h              show help
--version, -v           print the version

Installation

$ go get github.com/micheam/find-readme

Example

Show All readme.md or README.md under $HOME/go:

$ find-readme $HOME/go

Same as above but ignore some directory ¹:

$ find-readme --ignore pkg --ignore golang.org $HOME/go

License

MIT

Author

Michito Maeda https://github.com/micheam

Footnotes

1. node_modules will always ignored. ↩