{"id":29195760,"url":"https://github.com/md-command-line/readmegenerator","last_synced_at":"2026-02-03T23:03:08.759Z","repository":{"id":117098546,"uuid":"191982981","full_name":"md-command-line/readmegenerator","owner":"md-command-line","description":"(command-line/website) that analyzes your repo code percentage and adds nice sections such as the correct install instructions to your Readme in a safe manner.","archived":false,"fork":false,"pushed_at":"2019-06-14T18:46:55.000Z","size":3,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-02T05:05:49.215Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"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/md-command-line.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,"zenodo":null}},"created_at":"2019-06-14T17:36:27.000Z","updated_at":"2020-05-19T04:12:15.000Z","dependencies_parsed_at":null,"dependency_job_id":"3c1f88aa-72df-4e68-87fb-b0e63b450706","html_url":"https://github.com/md-command-line/readmegenerator","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/md-command-line/readmegenerator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/md-command-line%2Freadmegenerator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/md-command-line%2Freadmegenerator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/md-command-line%2Freadmegenerator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/md-command-line%2Freadmegenerator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/md-command-line","download_url":"https://codeload.github.com/md-command-line/readmegenerator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/md-command-line%2Freadmegenerator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29060635,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-03T22:28:58.191Z","status":"ssl_error","status_checked_at":"2026-02-03T22:28:56.515Z","response_time":96,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":[],"created_at":"2025-07-02T05:05:47.138Z","updated_at":"2026-02-03T23:03:08.747Z","avatar_url":"https://github.com/md-command-line.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"## Readme Generator\n\n(command-line/website) that analyzes your repo code percentage and adds nice sections such as the correct install instructions to your Readme in a safe manner.\n\n## Current Usage:\n```bash\n# not currently implemented npx readmegenerator\n```\n\n## Plan:\n\n1) get the organization and repo\n```bash\nurl=$(git remote get-url origin) \u0026\u0026\nsuffix=$(basename $url) \u0026\u0026\norganization=$(basename ${url%\"$suffix\"}) \u0026\u0026\nrepo=$(basename $url .git) \u0026\u0026\necho $organization $repo || echo 'something failed'\n```\n\n2) get the languages for the project:\n```\ncurl https://api.github.com/repos/michaeldimmitt/meetup-subscribe/languages\n{\n  \"JavaScript\": 27686,\n  \"HTML\": 1586,\n  \"CSS\": 848\n}\ncurl https://api.github.com/repos/michaeldimmitt/$dir/languages\n```\n3) Check the Readme to see if it needs install instructions:\n```bash\ncat R*.md | grep \"Setup\\|Usage\\|Install\"\n```\n\n4) Calculate the percentages and determine if they are acceptable to add install instructions to the readme.\n\n5) Download the winning Readme files:\n```bash\ncp R*.md AppendedReadme.md\ncurl -L https://raw.githubusercontent.com/MichaelDimmitt/readmegenerator/master/readmes/React.md \u003e\u003e AppendedReadme.md\ncurl -L https://raw.githubusercontent.com/MichaelDimmitt/readmegenerator/master/readmes/javascript.md \u003e\u003e AppendedReadme.md\n\necho 'Your readme is ready! check using: \ncat AppendedReadme.md; \n\nor accept the chages using:\nmv AppendedReadme.md; Readme.md;\n\nIf you do not like the resulting git diff, undo our changes with git checkout Readme.md; 😘'\n```\n\n## Alternatives if the Plan goes wrong.\n1) get the name of the project:\n```bash\ndir=${PWD##*/}\necho $dir\n```\n\n2) get the remote\n```\n# url=$(git remote -v | grep fetch | awk '{print $2}')\n# $(git config --get remote.origin.url)\n# this is not the correct url for api... maybe I will use gh_reveal's url parser to build the url.\n```\n\n## Additional Links:\nhttps://github.com/MichaelDimmitt/automate-shared-markdown/blob/master/Readme.md\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmd-command-line%2Freadmegenerator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmd-command-line%2Freadmegenerator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmd-command-line%2Freadmegenerator/lists"}