Code Monkey home page Code Monkey logo

tldw's Introduction

tldw

License Sponsor tldw
Build status Commits since v7.3.1 Last commit Issues
Latest version on npm Dependents Downloads

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

tldw on npm

npm install --global tldw@^7.3.1

tldw on Yarn

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 [email protected]: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 <[email protected]> (https://github.com/jaid)

tldw's People

Contributors

actions-user avatar depfu[bot] avatar github-actions[bot] avatar jaid avatar

Stargazers

avatar avatar

Watchers

avatar avatar avatar

Forkers

diotro

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.