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

get-good-readme

v2.1.0

Published

CLI tool to generate an esthetic README file πŸ”–πŸ”–

Downloads

12

Vulnerabilities

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

Links

Git

Maintainers

luctstluctst

Keywords

clicli-toolgenerate-readmereadmereadme-filesreadme-templatestemplatescli-templatetemplatesget-good-readme

Readme

Build Status NPM version Package size Dependencies devDependencies Status code style: prettier Twitter

Content

Features ✨

  • Fast.
  • Lightweight.
  • Quickly generate your README file.
  • Good for all kind of projects.

Install πŸ™

Note - If you had [email protected] or more you can skip this section.

You can install get-good-readme by entering this command

npm install -g get-good-readme

Usage πŸ’‘

  1. Create a new folder.
  2. Open your terminal and go inside the new folder.
  3. If you had npx:
    • if you had npx run npx get-good-readme and follow the instructions.
  4. If you don't have npx:
    • Check the install section to install the package globally.
    • Then execute the tasks number 1 and 2.
    • Run get-good-readme in your terminal.

Exemples πŸ–

npx get-good-readme -p=project-name -g=github-user -d="describe why you're creating this project."

Contributing 🍰

Please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who already contributed to this project!

Maintainers πŸ‘·

List of maintainers, replace all href, src attributes by your maintainers datas.

License βš–οΈ

MIT