{"id":15726818,"url":"https://github.com/usulpro/readme-pro","last_synced_at":"2026-04-16T04:31:49.970Z","repository":{"id":57169070,"uuid":"330208190","full_name":"usulpro/readme-pro","owner":"usulpro","description":"example of different readme files for Github and NPM","archived":false,"fork":false,"pushed_at":"2021-01-16T17:39:57.000Z","size":30,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-12T01:40:27.382Z","etag":null,"topics":["documentation","github","npm","readme"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@usulpro/readme-pro","language":"JavaScript","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/usulpro.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}},"created_at":"2021-01-16T16:40:51.000Z","updated_at":"2023-09-18T08:13:38.000Z","dependencies_parsed_at":"2022-09-13T08:30:28.738Z","dependency_job_id":null,"html_url":"https://github.com/usulpro/readme-pro","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/usulpro/readme-pro","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/usulpro%2Freadme-pro","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/usulpro%2Freadme-pro/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/usulpro%2Freadme-pro/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/usulpro%2Freadme-pro/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/usulpro","download_url":"https://codeload.github.com/usulpro/readme-pro/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/usulpro%2Freadme-pro/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31871478,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-15T15:24:51.572Z","status":"online","status_checked_at":"2026-04-16T02:00:06.042Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["documentation","github","npm","readme"],"created_at":"2024-10-03T22:40:45.338Z","updated_at":"2026-04-16T04:31:49.951Z","avatar_url":"https://github.com/usulpro.png","language":"JavaScript","readme":"# HOW TO HAVE DIFFERENT README FILES FOR GITHUB AND NPM?\n\nThis is **NPM version**\n\nSee also see [Github version](https://github.com/UsulPro/readme-pro)\n\n\u003eIf you put your README file in your repository's root, docs, or hidden .github directory, GitHub will recognize and automatically surface your README to repository visitors.\n\nOriginally the question was raised on Stackoverflow https://stackoverflow.com/questions/41297117/how-to-specify-different-readme-files-for-github-and-npm\n\n\u003cdiv align=\"left\" style=\"height: 16px;\"\u003eCreated with ❤︎ to \u003cb\u003estackoverflow community\u003c/b\u003e by \u003ca\n    href=\"https://twitter.com/UsulPro\"\u003e@usulpro\u003c/a\u003e [\u003ca href=\"https://github.com/react-theming\"\u003eReact Theming\u003c/a\u003e]\n\u003c/div\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fusulpro%2Freadme-pro","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fusulpro%2Freadme-pro","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fusulpro%2Freadme-pro/lists"}