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 🙏

© 2024 – Pkg Stats / Ryan Hefner

readme-auto

v1.0.3

Published

Auto-generate a beautiful README for a project based on its code comments.

Downloads

1

Vulnerabilities

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

Links

Git

Maintainers

ethancristethancrist

Keywords

readmegenerator

Readme

README Generator

logo

Auto-generate a beautiful README for a project based on its code comments.

This very README was generated from readme-generator! Supports any language that uses star comments.

Installation

npm i -g readme-auto

API

generate.js

generate [command]

Generate a README using any child code files of the current directory.

Usage


generate -m "<mainFile.js>" [ -i <ignore dir> ]

Options

--mainFile

Alias: -m Type: string Required: true

The relative location of the main file to your code. This will be the file whose code comments supply application metadata.

--ignore

Alias: -i Type: string Required: false

Ignore a code file or a set of code files within a directory when creating the README. For example:

generate -m mainFile.js -i node_modules

Would create documentation in the README for all files in the current directory and child directories EXCEPT anything in node_modules.