
Security News
require(esm) Backported to Node.js 20, Paving the Way for ESM-Only Packages
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
create-readme
Advanced tools
Automatically creates README.md based on package.json and other existing files.
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 --save
This package is provided in these module formats:
You can find a documentation here.
FAQs
Automatically creates README.md based on package.json and other existing files.
The npm package create-readme receives a total of 915 weekly downloads. As such, create-readme popularity was classified as not popular.
We found that create-readme demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.
Security News
Create React App is officially deprecated due to React 19 issues and lack of maintenance—developers should switch to Vite or other modern alternatives.