{"id":34213625,"url":"https://github.com/kylebanks/readme","last_synced_at":"2026-04-26T19:31:32.829Z","repository":{"id":153560001,"uuid":"113255104","full_name":"KyleBanks/readme","owner":"KyleBanks","description":"A command-line tool to fetch and display a projects README.","archived":false,"fork":false,"pushed_at":"2017-12-09T14:08:13.000Z","size":1026,"stargazers_count":2,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-12-19T02:26:50.686Z","etag":null,"topics":["command-line","command-line-tool","git","golang","open-source","productivity","productivity-booster","readme"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KyleBanks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-12-06T01:53:51.000Z","updated_at":"2020-04-22T17:23:55.000Z","dependencies_parsed_at":"2023-05-19T14:30:18.763Z","dependency_job_id":null,"html_url":"https://github.com/KyleBanks/readme","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/KyleBanks/readme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KyleBanks%2Freadme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KyleBanks%2Freadme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KyleBanks%2Freadme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KyleBanks%2Freadme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KyleBanks","download_url":"https://codeload.github.com/KyleBanks/readme/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KyleBanks%2Freadme/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32310804,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-26T19:15:34.056Z","status":"ssl_error","status_checked_at":"2026-04-26T19:15:15.467Z","response_time":129,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["command-line","command-line-tool","git","golang","open-source","productivity","productivity-booster","readme"],"created_at":"2025-12-15T21:55:09.025Z","updated_at":"2026-04-26T19:31:32.824Z","avatar_url":"https://github.com/KyleBanks.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# readme\n\n`readme` is a command-line tool to fetch and display the README of any open source project.\n\n**Note:** `readme` is a work-in-progress and currently unstable.\n\n## Installation\n\nGrab a stable binary from the [Releases](https://github.com/KyleBanks/readme/releases) page and add it to your `$PATH`, or install from source like so:\n\n```sh\n$ go get github.com/KyleBanks/readme\n```\n\n## Usage\n\nUsage is straightforward, simply execute `readme` with the username and repository you'd like to view:\n\n```sh\n$ readme KyleBanks/readme\n```\n\n![Example](./_example/example.png)\n\n## Options\n\n**-raw**:\n\nIf you prefer output in plain-text, use the `-raw` flag:\n\n```sh\n$ readme KyleBanks/readme -raw\n# readme\n\n`readme` is a command-line tool to fetch and display the README of any open source project.\n...\n```\n\n**-no-images**:\n\nBy default, `readme` attempts to render ASCII versions of all images in the README. If you'd prefer to skip image rendering, use the `-no-images` flag:\n\n```sh\n$ readme KyleBanks/goggles -no-images\n# goggles \n...\n[Image example.png]\n```\n\n## Authors\n\n- [Kyle Banks](https://kylewbanks.com/blog)\n\n## License\n\n```\nMIT License\n\nCopyright (c) 2017 Kyle Banks\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkylebanks%2Freadme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkylebanks%2Freadme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkylebanks%2Freadme/lists"}