Overwrites the readme based on info fetched from package.json and source code.
npm install --global tldw@^7.3.1
yarn global add tldw@^7.3.1
Generated readme can be extended with following files in your repository:
readme/config.yml
readme/envVars.yml
(same asreadme/config.yml#environmentVariables
)readme/usageOptions.yml
readme/example.js
readme/result*.js
readme/legal.md
readme/warning.md
readme/usage.md
readme/advancedUsage.md
readme/example.md
readme/options.md
readme/development.md
readme/description.md
readme/result.md
readme/notes.md
readme/related.md
readme/faq.md
After installing package tldw
globally, you can use its command line interface.
tldw
For usage instructions:
tldw --help
Development hints for maintaining and improving tldw
Setting up:
git clone [email protected]:jaid/tldw.git
cd tldw
npm install
Testing:
npm run test:dev
Testing in production environment:
npm run test
MIT License
Copyright © 2021, Jaid <[email protected]> (https://github.com/jaid)