search

zeke / package-json-to-readme

Generate README.md from package.json contents
npm.im/package-json-to-readme
384 stars 51 forks source link

Add different badges #11

Open dbartholomae opened 8 years ago

dbartholomae commented 8 years ago

Hi there,

it would be great if you could add multiple badges based on cli arguments. shields.io might be a useful resource as the urls are standardized for all badges. If you are interested I could create a pull request.

Best, Daniel

Knorcedger commented 8 years ago

+1

zkochan commented 8 years ago

@dbartholomae, I was inspired by this package and created mos

It has a lot of badges from shields.io and you can even specify what styles they should use mos-plugin-shields

dbartholomae commented 8 years ago

@zkochan Sounds interesting, I'll have a look! :)

dbartholomae commented 8 years ago

Actually I had already created a small module for myself. mos seems to be more versatile, although a little more complicated to use, too.

zkochan commented 8 years ago

Your module seems interesting as well. I'll inspect it tommorrow :smile:

By the way, I used this package for shields, maybe you can use it in your module as well or contribute

zeke commented 8 years ago

Hey all. Sorry I didn't notice this issue. I'd accept a PR that adds support for badges, either as CLI arguments, or perhaps within a badges object in package.json.

mos looks interesting! I'll have to give that a try.

zeke commented 8 years ago

Hey @zkochan I just added a section to package-json-to-readme's README linking to mos. Love the concept and the pluggability.

zkochan commented 8 years ago

Hey @zeke! Thanks!

I really like your description of mos

a pluggable module that injects content into your markdown files via hidden JavaScript snippets.

I will probably use it as the package and repo description :smile:

balupton commented 8 years ago

https://github.com/bevry/projectz accomplishes this via a badges property in the data file, that is then forwarded and rendered by https://github.com/bevry/badges - badge rendering has gone through a few Iterations over the years and quite happy with the way it is now - happy to improve either project for the larger communities needs