https://github.com/ryanburnette/badges

A strategy for adding badges to your lib readme.
https://github.com/ryanburnette/badges

Last synced: 17 days ago
JSON representation

A strategy for adding badges to your lib readme.

• Host: GitHub
• URL: https://github.com/ryanburnette/badges
• Owner: ryanburnette
• Created: 2019-10-10T00:23:24.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-10-10T14:04:56.000Z (over 5 years ago)
• Last Synced: 2024-12-19T20:13:58.771Z (about 2 months ago)
• Language: JavaScript
• Homepage:
• Size: 2.93 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# [badges][1]

[![repo](https://img.shields.io/badge/repository-Github-black.svg?style=flat-square)](https://github.com/ryanburnette/badges)

[![npm](https://img.shields.io/badge/package-NPM-green.svg?style=flat-square)](https://www.npmjs.com/package/@ryanburnette/badges)

A strategy for adding badges to your lib readme.

When you publish an NPM package, it is immediateley disseminated to many sites

other than NPM's. In order to keep the canonical locations available, my

strategy is to link the package name and to add two badges, one for the

repository and one for the NPM package.

```bash

npm install -g @ryanburnette/badges

cd my-project-dir

badges

```

This will generate the Markdown for the badges. Then I copy and paste them into

the readme.

[1]: https://github.com/ryanburnette/badges