This repository is in limited maintenance mode. Please consider migrating to jsx-readme.
Automatically creates README.md based on package.json and other existing files.
Configuration options can also be set in package.json's config.readme.
# API use
# Default options, explained in documentation
options = {
debug: false
silent: false
encoding: 'utf-8'
addDescription: ''
addUsage: ''
modules: ['CommonJS']
unpkg: false
licenseFile: 'LICENSE'
badges: ['npm-version', 'travis', 'coveralls', 'dependencies', 'devDependencies', 'gitter']
branch: 'master'
replaceModuleReferences: true
filename: 'README.md'
}
ReadmeCreator = require 'create-readme'
readmeCreator = new ReadmeCreator(options)
data = readmeCreator.parse()
content = readmeCreator.render data
readme = readmeCreator.write content
readme.catch (err) ->
throw err
process.exitCode = 1
readme-creator --encoding utf-8 --add-description "" --addUsage "" \
--modules CommonJS --no-unpkg --license-file LICENSE.txt \
--badges npm-version,travis,coveralls,dependencies,devDependencies,gitter \
--branch master \
README.md
Download node at nodejs.org and install it, if you haven't already.
npm install create-readme --saveThis package is provided in these module formats:
- CommonJS
You can find a documentation here.
- bluebird: Full featured Promises/A+ implementation with exceptionally good performance
- commander: the complete solution for node.js command-line programs
- debug: small debugging utility
- github-url-to-object: Extract user, repo, and other interesting properties from GitHub URLs
- mustache: Logic-less {{mustache}} templates with JavaScript
- require-all:
- @lluis/codo: A CoffeeScript documentation generator.
- @semantic-release/changelog: semantic-release plugin to create or update a changelog file
- coffee-script: Unfancy JavaScript
- coffeelint: Lint your CoffeeScript
- coffeelint-no-mocha-only: This CoffeeLint plugin verifies there are no describe.only's or it.only's left in mocha tests
- coffeelint-variable-scope: CoffeeLint rule that warn you when you accidentally overwrite outer scope variable
- coveralls: takes json-cov output into stdin and POSTs to coveralls.io
- ghooks: Simple git hooks
- mock-fs: A configurable mock file system. You know, for testing.
- nodemon: Simple monitor script for use during development of a node.js app.
- npm-build-tools: Cross-platform command-line tools to help use npm as a build tool.
- nsp: The Node Security (nodesecurity.io) command line interface
- proxyquire: Proxies nodejs require in order to allow overriding dependencies during testing.
- semantic-release: Automated semver compliant package publishing
- test-coffee-module: run tests on .coffee files with sensible defaults
- validate-commit-msg: Script to validate a commit message follows the conventional changelog standard
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
![greenkeeper[bot] avatar](https://avatars.githubusercontent.com/in/505?v=4 "greenkeeper[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent