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

git-a-readme

v1.5.0

Published

CLI Application that dynamically generates a professional git README. Information from package.json is used to help pre-populate responses if file exists. This project's README was generated using the node application.

Downloads

15

Vulnerabilities

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

Links

Git

Maintainers

shindekokoroshindekokoro

Keywords

GITREADMENODENPMmacOSlinuxraspberryPI

Readme

git-a-readme

License

Description

CLI Application that dynamically generates a professional git README. Information from package.json is used to help pre-populate responses if file exists. This project's README was generated using the node application.

Table of Contents

Installation

  1. Make sure node/npm is installed on your system. Goto: https://nodejs.org/en/download/package-manager
  2. Make sure to set your preferred console text editor (I recommend NANO)
    export EDITOR=nano
export VISUAL="$EDITOR"
  3. npm i git-a-readme

Preview

Usage

  • If git-a-readme is in the root directory of your project type npm start into the terminal and then follow the prompts to create readme file.
  • If git-a-readme is in your node_modules folder from npm install type: node node_modules/git-a-readme/index.js and follow the prompts from there.
  • Add as a package.json run script. Insert "readme": "node ./node_modules/git-a-readme/index.js" into scripts section of package.json

License

MIT

A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.

Contributing

Contributions are very welcomed, however please follow the below guidelines.

  • First open an issue/pull request describing the bug or enhancement so it can be discussed.
  • Create a pull request with your changes against the main branch.
  • Match current naming conventions as closely as possible, and stay within the scope of the description for the project.

Tests

Tested on Debian Linux (Raspbian OS / Raspberry Pi 4), and macOS.

Questions

If you have any questions feel free to use the links below:

GitHub Profile: https://github.com/shindekokoro

Email: [email protected]