{"id":21557400,"url":"https://github.com/dbartholomae/create-readme","last_synced_at":"2025-04-10T10:34:10.733Z","repository":{"id":6584187,"uuid":"49607053","full_name":"dbartholomae/create-readme","owner":"dbartholomae","description":"Automatically creates README.md based on package.json and other existing files","archived":false,"fork":false,"pushed_at":"2022-12-11T22:58:53.000Z","size":1561,"stargazers_count":1,"open_issues_count":11,"forks_count":12,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-14T12:39:03.611Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CoffeeScript","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/dbartholomae.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":"2016-01-13T22:43:57.000Z","updated_at":"2022-03-14T14:44:03.000Z","dependencies_parsed_at":"2023-01-11T20:09:48.904Z","dependency_job_id":null,"html_url":"https://github.com/dbartholomae/create-readme","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbartholomae%2Fcreate-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbartholomae%2Fcreate-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbartholomae%2Fcreate-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbartholomae%2Fcreate-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dbartholomae","download_url":"https://codeload.github.com/dbartholomae/create-readme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248199245,"owners_count":21063641,"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-11-24T08:12:09.336Z","updated_at":"2025-04-10T10:34:10.702Z","avatar_url":"https://github.com/dbartholomae.png","language":"CoffeeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Limited maintenance\n\nThis repository is in limited maintenance mode. Please consider migrating to [jsx-readme](https://github.com/dbartholomae/jsx-readme).\n\n# create-readme\n [![npm version](https://badge.fury.io/js/create-readme.svg)](https://npmjs.org/package/create-readme)  [![downloads](https://img.shields.io/npm/dw/create-readme.svg)](https://npmjs.org/package/create-readme)  [![open issues](https://img.shields.io/github/issues-raw/dbartholomae/create-readme.svg)](https://github.com/dbartholomae/create-readme/issues)  [![license](https://img.shields.io/github/license/dbartholomae/create-readme.svg)](https://github.com/dbartholomae/create-readme/blob/master/LICENSE)  [![debug](https://img.shields.io/badge/debug-blue.svg)](https://github.com/visionmedia/debug#readme)  [![build status](https://img.shields.io/travis/dbartholomae/create-readme/master.svg)](https://travis-ci.org/dbartholomae/create-readme#master)  [![coverage status](https://coveralls.io/repos/dbartholomae/create-readme/badge.svg)](https://coveralls.io/github/dbartholomae/create-readme)  [![dependency status](https://david-dm.org/dbartholomae/create-readme.svg?theme=shields.io)](https://david-dm.org/dbartholomae/create-readme)  [![devDependency status](https://david-dm.org/dbartholomae/create-readme/dev-status.svg)](https://david-dm.org/dbartholomae/create-readme#info=devDependencies)  [![semantic release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release#badge)  [![Gitter](https://badges.gitter.im/dbartholomae/create-readme.svg)](https://gitter.im/dbartholomae/create-readme) \n\nAutomatically creates README.md based on package.json and other existing files.\n\n## Usage\n\nConfiguration options can also be set in package.json's config.readme.\n\n```coffeescript\n# API use\n\n# Default options, explained in documentation\noptions = {\n  debug: false\n  silent: false\n  encoding: 'utf-8'\n  addDescription: ''\n  addUsage: ''\n  modules: ['CommonJS']\n  unpkg: false\n  licenseFile: 'LICENSE'\n  badges: ['npm-version', 'travis', 'coveralls', 'dependencies', 'devDependencies', 'gitter']\n  branch: 'master'\n  replaceModuleReferences: true\n  filename: 'README.md'\n}\n\nReadmeCreator = require 'create-readme'\nreadmeCreator = new ReadmeCreator(options)\ndata = readmeCreator.parse()\ncontent = readmeCreator.render data\nreadme = readmeCreator.write content\nreadme.catch (err) -\u003e\n  throw err\n  process.exitCode = 1\n\n```\n\n```sh\nreadme-creator --encoding utf-8 --add-description \"\" --addUsage \"\" \\\n  --modules CommonJS --no-unpkg --license-file LICENSE.txt \\\n  --badges npm-version,travis,coveralls,dependencies,devDependencies,gitter \\\n  --branch master \\\n  README.md\n\n```\n\n\n## Installation\nDownload node at [nodejs.org](http://nodejs.org) and install it, if you haven't already.\n\n```sh\nnpm install create-readme --save\n```\n\nThis package is provided in these module formats:\n\n- CommonJS\n\n\n\n## Documentation\n\nYou can find a documentation [here](https://dbartholomae.github.io/create-readme/).\n\n## Dependencies\n\n- [bluebird](https://github.com/petkaantonov/bluebird): Full featured Promises/A+ implementation with exceptionally good performance\n- [commander](https://github.com/tj/commander.js): the complete solution for node.js command-line programs\n- [debug](https://github.com/visionmedia/debug): small debugging utility\n- [github-url-to-object](https://github.com/zeke/github-url-to-object): Extract user, repo, and other interesting properties from GitHub URLs\n- [mustache](https://github.com/janl/mustache.js): Logic-less {{mustache}} templates with JavaScript\n- [require-all](): \n\n\n## Dev Dependencies\n\n- [@lluis/codo](https://github.com/coffeedoc/codo): A CoffeeScript documentation generator.\n- [@semantic-release/changelog](https://github.com/semantic-release/changelog): semantic-release plugin to create or update a changelog file\n- [coffee-script](https://github.com/jashkenas/coffeescript): Unfancy JavaScript\n- [coffeelint](https://github.com/clutchski/coffeelint): Lint your CoffeeScript\n- [coffeelint-no-mocha-only](https://github.com/rkstedman/coffeelint-no-mocha-only): This CoffeeLint plugin verifies there are no describe.only's or it.only's left in mocha tests\n- [coffeelint-variable-scope](https://github.com/fragphace/coffeelint-variable-scope): CoffeeLint rule that warn you when you accidentally overwrite outer scope variable\n- [coveralls](https://github.com/nickmerwin/node-coveralls): takes json-cov output into stdin and POSTs to coveralls.io\n- [ghooks](https://github.com/gtramontina/ghooks): Simple git hooks\n- [mock-fs](https://github.com/tschaub/mock-fs): A configurable mock file system.  You know, for testing.\n- [nodemon](https://github.com/remy/nodemon): Simple monitor script for use during development of a node.js app.\n- [npm-build-tools](https://github.com/Deathspike/npm-build-tools): Cross-platform command-line tools to help use npm as a build tool.\n- [nsp](https://github.com/nodesecurity/nsp): The Node Security (nodesecurity.io) command line interface\n- [proxyquire](https://github.com/thlorenz/proxyquire): Proxies nodejs require in order to allow overriding dependencies during testing.\n- [semantic-release](https://github.com/semantic-release/semantic-release): Automated semver compliant package publishing\n- [test-coffee-module](https://github.com/dbartholomae/test-coffee-module): run tests on .coffee files with sensible defaults\n- [validate-commit-msg](https://github.com/conventional-changelog/validate-commit-msg): Script to validate a commit message follows the conventional changelog standard\n\n\n## License\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdbartholomae%2Fcreate-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdbartholomae%2Fcreate-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdbartholomae%2Fcreate-readme/lists"}