Overwrites the readme based on info fetched from package.json and source code.
npm install --global tldw@^6.11.0
yarn global add tldw@^6.11.0
(if configured properly)
npm install --global @jaid/tldw@^6.11.0Generated 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.jsreadme/result*.js
readme/legal.mdreadme/warning.mdreadme/usage.mdreadme/advancedUsage.mdreadme/example.mdreadme/options.mdreadme/development.mdreadme/description.mdreadme/result.mdreadme/related.mdreadme/faq.md
After installing package tldw globally, you can use its command line interface.
tldwFor usage instructions:
tldw --helpSetting up:
git clone [email protected]:jaid/tldw.git
cd tldw
npm installTesting:
npm run test:devTesting in production environment:
npm run testMIT License
Copyright © 2020, Jaid <[email protected]> (https://github.com/jaid)
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "github-actions[bot]")
![depfu[bot] avatar](https://avatars.githubusercontent.com/in/715?v=4 "depfu[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent