{"id":18056256,"url":"https://github.com/micheam/find-readme","last_synced_at":"2025-04-05T09:44:53.583Z","repository":{"id":107585983,"uuid":"218275801","full_name":"micheam/find-readme","owner":"micheam","description":"CLI Application which find README.md under path","archived":false,"fork":false,"pushed_at":"2019-10-29T17:33:22.000Z","size":4,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-18T04:18:23.640Z","etag":null,"topics":["cli-app","golang","sample-code","toy-application"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/micheam.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-10-29T11:55:34.000Z","updated_at":"2024-06-19T07:59:50.415Z","dependencies_parsed_at":null,"dependency_job_id":"57e3d054-ada3-44aa-a48a-07c61f2873ac","html_url":"https://github.com/micheam/find-readme","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micheam%2Ffind-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micheam%2Ffind-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micheam%2Ffind-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micheam%2Ffind-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/micheam","download_url":"https://codeload.github.com/micheam/find-readme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247318721,"owners_count":20919483,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli-app","golang","sample-code","toy-application"],"created_at":"2024-10-31T01:14:29.439Z","updated_at":"2025-04-05T09:44:53.565Z","avatar_url":"https://github.com/micheam.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# find readme\n\n`find-readme` - Find README.md under path.\n\n## DON'T USE THIS\n\nThis App is a sample implementation for using `path/filepath/Walk`.  \nUse [the_silver_searcher](https://github.com/ggreer/the_silver_searcher) is more faster and powerful 😌\n\n```sh\n$ function find-readme { ag -l \"\" ${1:?} | ag -i 'readme.md'; }\n$ find-readme ~/go\n```\n\nsee [benchmark](./bench.md)\n\n## Usage\n\n```\n$ find-readme [global options] command [command options] path ...\n```\n\n### COMMANDS:\n```\nhelp, h  Shows a list of commands or help for one command\n```\n\n### GLOBAL OPTIONS:\n```\n--ignore name, -i name  Directory name to ignore.\n--help, -h              show help\n--version, -v           print the version\n```\n\n## Installation\n```\n$ go get github.com/micheam/find-readme\n```\n\n## Example\n\nShow All readme.md or README.md under _$HOME/go_:\n\n    $ find-readme $HOME/go\n\nSame as above but ignore some directory [^1]:\n\n    $ find-readme --ignore pkg --ignore golang.org $HOME/go\n\n[^1]: `node_modules` will always ignored.\n\n## License\nMIT\n\n## Author\nMichito Maeda \u003chttps://github.com/micheam\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicheam%2Ffind-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicheam%2Ffind-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicheam%2Ffind-readme/lists"}