npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

tldw

v8.0.1

Published

Generate README files from package metadata and configurable fragments.

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

jaidjaid

Keywords

bunclidocumentationmarkdownreadmereadme-template

Readme

.text { font-size: 500px; font-weight: 200; font-family: JetBrains Mono, JetBrainsMono, monospace }tl;dw

tl;dw

Generate README files from package metadata and configurable fragments.

Installation

npm install --save-dev tldw

Usage

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

Config

  • docs/tldw/config.yml

Useful docs/tldw/config.yml fields include:

  • banner: true, a string or {text, font, topColor, bottomColor}
  • shields: an array for one shield line or an array of arrays for multiple shield lines. Each shield can be a string ID or a custom shield definition object
  • excludeShields: a string or array of strings with shield IDs to skip
  • packageManagers: a string or array of npm, pnpm, yarn and bun to choose which package managers are shown in ## Installation. Default is npm
  • versionInInstallation: if true, append @^<version> to installation commands
  • maxBlankLines: maximum number of consecutive blank lines in generated Markdown

YAML representation of Markdown fragments

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

Code fragments

  • docs/tldw/example.ts, docs/tldw/example.tsx, docs/tldw/example.js or docs/tldw/example.jsx
  • docs/tldw/usage.ts or docs/tldw/usage.tsx
  • docs/tldw/result.js or docs/tldw/result.jsx for a result shown below the usage code
  • docs/tldw/result*.ts, docs/tldw/result*.tsx, docs/tldw/result*.js or docs/tldw/result*.jsx for named example results

Markdown fragments

  • docs/tldw/legal.md
  • docs/tldw/warning.md
  • docs/tldw/usage.md
  • docs/tldw/advancedUsage.md
  • docs/tldw/example.md
  • docs/tldw/options.md
  • docs/tldw/development.md
  • docs/tldw/description.md
  • docs/tldw/result.md
  • docs/tldw/notes.md
  • docs/tldw/related.md
  • docs/tldw/faq.md

Development

setting up

git clone [email protected]:Jaid/tldw.git
cd tldw
bun install

linting

bun run lint

type checking

bun run typecheck

testing

bun run test

License

MIT License
Copyright © 2026, Jaid <[email protected]> (https://github.com/Jaid)