create-readme@1.1.0

Automatically creates README.md based on package.json and other existing files.

This package was heavily inspired by package-json-to-readme. It makes use of http://rawgit.com/ to serve the documentation and of http://npmcdn.com/ to serve the module. Both are only suitable for small projects.

Usage

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']
  npmcdn: false
  licenseFile: 'LICENSE.txt'
  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-npmcdn --license-file LICENSE.txt \
  --badges npm-version,travis,coveralls,dependencies,devDependencies,gitter \
  --branch master \
  README.md

Installation

Download node at nodejs.org and install it, if you haven't already.

npm install create-readme --save

This package is provided in these module formats:

CommonJS

Documentation

You can find a documentation here.

Dependencies

bluebird: Full featured Promises/A+ implementation with exceptionally good performance
commander: the complete solution for node.js command-line programs
github-url-to-object: Extract user, repo, and other interesting properties from GitHub URLs
mustache: Logic-less {{mustache}} templates with JavaScript
require-all: An easy way to require all files within a directory.
winston: A multi-transport async logging library for Node.js

Dev Dependencies

codo: A CoffeeScript documentation generator.
coffee-script: Unfancy JavaScript
coveralls: takes json-cov output into stdin and POSTs to coveralls.io
ghooks: Simple git hooks
lint-coffee-strict: coffeelint preconfigured with WappForge style guide
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
write-version-to-package-json: Loads the current version from the npm registry and writes it to package.json

License

MIT

rmzxcm / create-readme