Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/greybax/generator-badges
Yeoman generator for adding badges to your README.md
https://github.com/greybax/generator-badges
badge badge-generator badge-view badger badgers badges badgeview boilerplate generate generator generator-badges generators readme readme-badges readme-bolierplate readme-standard scaffold scaffolding yeoman yeoman-generator
Last synced: 2 months ago
JSON representation
Yeoman generator for adding badges to your README.md
- Host: GitHub
- URL: https://github.com/greybax/generator-badges
- Owner: greybax
- Created: 2016-02-25T23:47:37.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2019-06-10T20:21:50.000Z (over 5 years ago)
- Last Synced: 2024-08-11T11:57:51.670Z (6 months ago)
- Topics: badge, badge-generator, badge-view, badger, badgers, badges, badgeview, boilerplate, generate, generator, generator-badges, generators, readme, readme-badges, readme-bolierplate, readme-standard, scaffold, scaffolding, yeoman, yeoman-generator
- Language: JavaScript
- Size: 30.3 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# generator-badges
[](https://greenkeeper.io/)
[![NPM version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Coveralls Status][coveralls-image]][coveralls-url]
[![Dependency Status][depstat-image]][depstat-url]
[![DevDependency Status][depstat-dev-image]][depstat-dev-url]
> [Yeoman](http:\\yeoman.io) generator for adding badges to your README.md
> Works great as cli and with other generators too.
## Install
npm install --global yo generator-badges
## Usage
yo badges noPrompts -u i-am-user -p my-awesome-project -b travis,npm
This command creates ```README.md``` (if doesn't exist) or created one and put there follow rows on the top:
[![Build Status][travis-image]][travis-url]
[travis-url]: https://travis-ci.org/i-am-user/my-awesome-project
[travis-image]: https://img.shields.io/travis/i-am-user/my-awesome-project/master.svg?style=flat-square
[![NPM version][npm-image]][npm-url]
[npm-url]: https://npmjs.org/package/my-awesome-project
[npm-image]: https://img.shields.io/npm/v/my-awesome-project.svg?style=flat-square
**OR**
you can use ```prompt``` mode:
yo badges
Now supports follow badges in options:
- ```appveyor``` — NPM version
- ```npm``` — NPM version
- ```travis``` — Travis CI
- ```coveralls``` — coveralls.io
- ```dependencies``` — dependency status
- ```devDependencies``` — devDependency status
- ```codeship``` — codeship build status
- ```scrutinizer``` — scrutinizer code quality
- ```wercker``` — [wercker.com](wercker.com)
## Composability
> Composability is a way to combine smaller parts to make one large thing. Sort of [like Voltron®](http://25.media.tumblr.com/tumblr_m1zllfCJV21r8gq9go11_250.gif)
> — Yeoman docs
Just plug in for generates badges into your README.md into your generator.
### Install
npm install --save generator-badges
### Compose
```js
this.composeWith('badges', { options: {
'skip-install': this.options['skip-install'],
config: {
user: "i-am-user",
project: "my-awesome-project",
badges: ['travis', 'npm']
}}}, {
local: require.resolve('generator-badges')
});
```
## License
MIT © Aleksandr Filatov [alfilatov.com](https://alfilatov.com)
[npm-url]: https://npmjs.org/package/generator-badges
[npm-image]: https://img.shields.io/npm/v/generator-badges.svg?style=flat-square
[travis-url]: https://travis-ci.org/greybax/generator-badges
[travis-image]: https://img.shields.io/travis/greybax/generator-badges/master.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/greybax/generator-badges
[coveralls-image]: https://img.shields.io/coveralls/greybax/generator-badges/master.svg?style=flat-square
[depstat-url]: https://david-dm.org/greybax/generator-badges
[depstat-image]: https://david-dm.org/greybax/generator-badges.svg?style=flat-square
[depstat-dev-url]: https://david-dm.org/greybax/generator-badges#info=devDependencies
[depstat-dev-image]: https://david-dm.org/greybax/generator-badges/dev-status.svg?style=flat-square