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

pi-readme

v1.0.0

Published

Pi-native README generator and linter for pi.dev packages — auto-generate and validate README.md files

Vulnerabilities

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

Links

Maintainers

realvendexrealvendex

Keywords

pi-packagepireadmedocumentationgeneratorlinter

Readme

pi-readme

Pi-native README generator and linter for pi.dev packages — auto-generate and validate README.md files.

npm version

Installation

pi install npm:pi-readme

What It Does

Auto-generates and validates README.md files for pi.dev packages. Reads your package.json, extension tools, and CHANGELOG.md to create a pi-native README with proper install commands, tools documentation, and peer dependencies.

Keywords: pi-package, pi, readme, documentation, generator, linter

Tools

readme_generate

Generate a README.md for a pi.dev package from package.json metadata, extension tools, and changelog. Creates a pi-native README with proper install commands, tools documentation, and peer dependencies.

Parameters:

  • path (string, optional) — Path to the package directory (defaults to cwd)
  • template_overrides (Record<string, string>, optional) — Optional overrides for template sections

Example:

Use the readme_generate tool with path="./my-pi-package"

readme_lint

Validate a README.md against pi.dev best practices. Checks for install commands, proper pi install npm: format, description, tools section, license, heading hierarchy, and pi-package keyword.

Parameters:

  • readme_path (string, optional) — Path to the README.md file (defaults to ./README.md)
  • package_path (string, optional) — Path to the package directory (defaults to cwd)

Example:

Use the readme_lint tool to check your README

Commands

/readme generate [path]

Generate README for a pi.dev package.

/readme lint [path]

Validate README against pi.dev standards.

Peer Dependencies

  • @earendil-works/pi-coding-agent >=0.74.0
  • typebox >=1.0.0

Version: 1.0.0

Resources

License

MIT