Jaid / tldw

Overwrites the readme based on info fetched from package.json and source code.

tldw

Overwrites the readme based on info fetched from package.json and source code.

Opinionated

⚠️ This project is tailored to my personal needs and workflows and therefore highly opinionated. Feel free to use it or get inspired by it, but please do not get frustrated if you come across weird features or difficulties integrating it in your own ecosystem.

Installation

npm install --global tldw@^7.3.1

yarn global add tldw@^7.3.1

Usage

Generated readme can be extended with following files in your repository:

Config

• readme/config.yml

YAML representation of Markdown fragments

• readme/envVars.yml (same as readme/config.yml#environmentVariables)
• readme/usageOptions.yml

JavaScript fragments

• readme/example.js
• readme/result*.js

Markdown fragments

• 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

CLI Usage

After installing package tldw globally, you can use its command line interface.

tldw

For usage instructions:

tldw --help

Development

Development hints for maintaining and improving tldw

Setting up:

git clone [e-mail]:jaid/tldw.git
cd tldw
npm install

Testing:

npm run test:dev

Testing in production environment:

npm run test

License

MIT License
Copyright © 2021, Jaid <[e-mail]> (https://github.com/jaid)