{"id":16253342,"url":"https://github.com/arman2409/nestjs-readme","last_synced_at":"2026-02-27T15:38:19.732Z","repository":{"id":246570019,"uuid":"820852761","full_name":"Arman2409/nestjs-readme","owner":"Arman2409","description":"NPM package for generating documentation for Nest.js projects","archived":false,"fork":false,"pushed_at":"2025-03-25T11:42:25.000Z","size":92,"stargazers_count":1,"open_issues_count":8,"forks_count":0,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-03-25T12:35:49.162Z","etag":null,"topics":["documentation","nestjs","npm-package","readme"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/nestjs-readme","language":"TypeScript","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/Arman2409.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}},"created_at":"2024-06-27T09:59:06.000Z","updated_at":"2025-03-25T11:42:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"55b7a46f-76f1-40f7-bffc-13041d8165f5","html_url":"https://github.com/Arman2409/nestjs-readme","commit_stats":null,"previous_names":["arman2409/nestjs-readme"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Arman2409%2Fnestjs-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Arman2409%2Fnestjs-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Arman2409%2Fnestjs-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Arman2409%2Fnestjs-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Arman2409","download_url":"https://codeload.github.com/Arman2409/nestjs-readme/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247471524,"owners_count":20944158,"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":["documentation","nestjs","npm-package","readme"],"created_at":"2024-10-10T15:16:49.083Z","updated_at":"2026-02-27T15:38:19.212Z","avatar_url":"https://github.com/Arman2409.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 style=\"text-align: center; border-bottom: 1px solid green\"\u003e Nestjs-readme\n\u003c/h1\u003e\n\n`Generate basic README.md file for your Nest.js project`\n\n- [Usage](#usage)\n- [Available Commands](#commands)\n- [Features](#features)\n\n\u003ch2 id=\"usage\" style=\"text-align: center\"\u003e\n  Usage\n\u003c/h2\u003e\n\n#### Installation\n```bash\n npm install nestjs-readme\n```\n\n#### Usage\n```bash\n npx nestjs-readme gen\n```\n\n\u003ch2 id=\"commands\" style=\"text-align: center\"\u003e\n  Available Commands\n\u003c/h2\u003e\n\n- generate/gen    Generates README.md file for your project with default configuration\n- --help          You can get more info about package's usage with this command\n\n\u003ch2 id=\"features\" style=\"text-align: center\"\u003e\n  Features\n\u003c/h2\u003e\n\nThis package can help you to generate basic README for your Nest.js project by extracting information from your project such as\n- Title and description\n- Commands\n- Environment variables\n- Controllers\n\n### Title and Description\nThis package will look for title and description in package.json, otherwise it will add basic info.\n\n### Commands\nThis package will look for basic commands used in Nest.js projects, like \"start\" and \"test\" in your package.json's scripts section and if they are present, it will add them.\n\n### Environment variables \nThe following files \".env\", '.env.production' and '.env.development' will be scanned for environment variables and if there are any variables, they will be added as well.The environment variables are expected to be in this format VARIABLE_NAME=\"value\".\n\n### Controllers\nThis is Nest.js specific feature.If your project has Nest.js-like structure and has \"./src/\" folder, the package will look for controllers in each module and then list them readme with their endpoints with there parameters and paths.Note that GraphQL and other kind of APIs endpoints aren't supported yet.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farman2409%2Fnestjs-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farman2409%2Fnestjs-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farman2409%2Fnestjs-readme/lists"}