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

generator-badge

v1.2.0

Published

Generate badges for your readme

Downloads

79

Vulnerabilities

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

Links

Git

Maintainers

tanhauhautanhauhau

Keywords

generatebadgebadgesreadmemarkdowntextilerdocrstpodhtmlnodetraviswerckerappveyornpmapmdavidgittergithubgeneratorshieldshieldsshields.io

Readme

generator-badge

travis status appveyor status wercker status wercker status
npm version npm license npm download npm download david dependency david dev-dependency
GitHub followers GitHub forks GitHub stars GitHub watchers GitHub issues

Generate badges for your readme

Installation

$ npm install --save --global generator-badge

Example

BEFORE

README.md:

# MY-AWESOME-PROJECT
<!-- badge -->
<!-- endbadge -->

THEN YOU DO

Terminal:

awesome-project$ badge install travis npm-version

WHAT YOU GET

README.md:

# MY-AWESOME-PROJECT
<!-- badge -->
[![travis](https://img.shields.io/travis/tanhauhau/awesome-project.svg)](https://travis-ci.org/tanhauhau/awesome-project)
[![npm-version](https://img.shields.io/npm/v/awesome-project.svg)](https://www.npmjs.com/package/awesome-project)
<!-- endbadge -->

Usage

Install badges

$ badge install <badges> [<args>]

You can specify required field values into arguments:

$ badge install travis --repo-username=tanhauhau --repo-name=awesome-project

For field values that is missing, badge will prompt you to enter.

install

*All the information gathered will be stored at .badge.json in the same folder as the nearest README.

Other options available

--no-cache
Do not use information stored in .badge.json.

--ignore-warning
Install badges even if some badges specified does not exists.

List of installed badge(s)

$ badge installed

List of all badges available

$ badge list <badges>

You can list all the badges available

$ badge list

listing

List of badges that will be installed

$ badge list <badges>

Example

$ badge list apm tavis

listing

Note typo in Travis. This command shows what will be installed, a typo in Tavis will install nothing

Help

$ badge help <badge>

help

Clear

$ badge clear

Remove all badges

Badges Available

See a list of badges available here.

Todo List

  • [ ] Find README of various format: markdown, textile, rdoc, rst, pod, html
  • [ ] Inferring ~~git~~, svn repo information
  • [ ] Storing global preferences, eg: able to remember author name in global
  • [x] Storing local preferences, eg: able to remember repo info in local package
  • [ ] Filename as argument
  • [ ] More badges available

Badge credits to

shields.io

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

License

MIT