{"id":15598229,"url":"https://github.com/boneskull/node-open-readme","last_synced_at":"2025-07-04T08:39:59.778Z","repository":{"id":57315113,"uuid":"19899247","full_name":"boneskull/node-open-readme","owner":"boneskull","description":"Open the README of an installed NPM module in its default application.","archived":false,"fork":false,"pushed_at":"2018-10-17T16:59:07.000Z","size":14,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-29T22:37:22.505Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/boneskull.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}},"created_at":"2014-05-18T00:13:08.000Z","updated_at":"2020-12-11T23:13:31.000Z","dependencies_parsed_at":"2022-09-18T20:51:05.094Z","dependency_job_id":null,"html_url":"https://github.com/boneskull/node-open-readme","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boneskull%2Fnode-open-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boneskull%2Fnode-open-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boneskull%2Fnode-open-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boneskull%2Fnode-open-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/boneskull","download_url":"https://codeload.github.com/boneskull/node-open-readme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247128753,"owners_count":20888235,"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":[],"created_at":"2024-10-03T01:31:56.431Z","updated_at":"2025-04-04T06:13:01.467Z","avatar_url":"https://github.com/boneskull.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# open-readme\n\nOpen the `README` of an installed NPM module in its default application.  \n\n\u003e This script conflicts with the [readme](https://www.npmjs.org/package/readme) module, as they use the same script name.  The difference is that this script will open the default application.\n\n## Viewers\n\nMost `README` files are written in [Markdown](http://en.wikipedia.org/wiki/Markdown). \n\nIf on OS X, I recommend [Marked](http://marked2app.com/).\n\nThere are also many [Markdown viewers](https://chrome.google.com/webstore/search/markdown) available in the Chrome Web Store.\n\n## Installation\n\nThis is a command-line application and should be installed globally.\n\n```shell\nnpm install -g readme\n```\n\n## Usage\n\n```\nOpen the README of an installed NPM module in its default application.\nIf no MODULE_NAME specified, tries to open the first README it can find.\n\nreadme [-d|--deep] [-s|--shallow] [-v|--verbose] [-g|--global] [MODULE_NAME]\n\nOptions:\n  -d, --deep     Dig into dependencies of dependencies            [default: true]\n  -s, --shallow  Look only in the current project's dependencies\n  -v, --verbose  Enable useless information                     \n  -h, --help     You're reading it.                             \n  -g, --global   Search global modules                          \n```\n\nIf a `README` is found in a format *other* than Markdown, the default application for its extension (or lack thereof) will be opened.  \n\n\u003e `--global`, `--deep` and `--shallow` do nothing if no `MODULE_NAME` is given.\n\n## License\n\nMIT\n\n## Author\n\n[Christopher Hiller](http://boneskull.github.io)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboneskull%2Fnode-open-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fboneskull%2Fnode-open-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboneskull%2Fnode-open-readme/lists"}