generator-shields

generator-shields

Yeoman generator

Easily add shields to your README file. Available shields:

• --npm current version in npm;
• --travis current build status from Travis CI;
• --coverage test coverage from Coveralls;
• --climate code climate rate from Code Climate;
• --deps dependencies from David DM;
• --devdeps dev dependencies from David DM;
• --peerdeps peer devdependencies from David DM.

Usage

npm install -g yo generator-shields
yo shields

Getting Started

What is Yeoman?

Trick question. It's not a thing. It's this guy:

Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.

Not every new computer comes with a Yeoman pre-installed. He lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.

npm install -g yo

Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.

To install generator-shields from npm, run:

npm install -g generator-shields

Finally, initiate the generator:

yo shields

Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.

If you'd like to get to know Yeoman better and meet some of his friends, Grunt and Bower, check out the complete Getting Started Guide.

License

MIT