https://github.com/tanhauhau/generator-badge

Generate badges for your readme
https://github.com/tanhauhau/generator-badge

Last synced: 3 months ago
JSON representation

Generate badges for your readme

• Host: GitHub
• URL: https://github.com/tanhauhau/generator-badge
• Owner: tanhauhau
• License: mit
• Created: 2016-04-26T07:06:47.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-05-13T07:10:40.000Z (about 9 years ago)
• Last Synced: 2024-05-01T13:30:56.277Z (about 1 year ago)
• Language: JavaScript
• Size: 463 KB
• Stars: 27
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# generator-badge

[![travis status](https://img.shields.io/travis/tanhauhau/generator-badge.svg)](https://travis-ci.org/tanhauhau/generator-badge)

[![appveyor status](https://img.shields.io/travis/tanhauhau/generator-badge.svg)](https://ci.appveyor.com/project/tanhauhau/generator-badge)

[![wercker status](https://app.wercker.com/status/15d1bfe55ec05c73b82704c4912f4323/s)](https://app.wercker.com/project/bykey/15d1bfe55ec05c73b82704c4912f4323)

[![wercker status](https://app.wercker.com/status/15d1bfe55ec05c73b82704c4912f4323/m)](https://app.wercker.com/project/bykey/15d1bfe55ec05c73b82704c4912f4323)  

[![npm version](https://img.shields.io/npm/v/generator-badge.svg)](https://www.npmjs.com/package/generator-badge)

[![npm license](https://img.shields.io/npm/l/generator-badge.svg)](https://www.npmjs.com/package/generator-badge)

[![npm download](https://img.shields.io/npm/dm/generator-badge.svg)](https://www.npmjs.com/package/generator-badge)

[![npm download](https://img.shields.io/npm/dt/generator-badge.svg)](https://www.npmjs.com/package/generator-badge)

[![david dependency](https://img.shields.io/david/tanhauhau/generator-badge.svg)]()

[![david dev-dependency](https://img.shields.io/david/dev/tanhauhau/generator-badge.svg)]()  

[![GitHub followers](https://img.shields.io/github/followers/tanhauhau.svg?style=social&label=Follow)](https://github.com/tanhauhau/generator-badge)

[![GitHub forks](https://img.shields.io/github/forks/tanhauhau/generator-badge.svg?style=social&label=Fork)](https://github.com/tanhauhau/generator-badge/fork)

[![GitHub stars](https://img.shields.io/github/stars/tanhauhau/generator-badge.svg?style=social&label=Star)](https://github.com/tanhauhau/generator-badge)

[![GitHub watchers](https://img.shields.io/github/watchers/tanhauhau/generator-badge.svg?style=social&label=Watch)](https://github.com/tanhauhau/generator-badge)

[![GitHub issues](https://img.shields.io/github/issues/tanhauhau/generator-badge.svg?style=social)](https://github.com/tanhauhau/generator-badge/issues)

> Generate badges for your readme

# Installation

```bash

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

```

## Example

**BEFORE**

README.md:

```markdown

# MY-AWESOME-PROJECT

```

**THEN YOU DO**

Terminal:

```bash

awesome-project$ badge install travis npm-version

```

**WHAT YOU GET**

README.md:

```markdown

# MY-AWESOME-PROJECT

[![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)

```

## Usage

**Install badges**

```bash

$ badge install  []

```

You can specify required field values into arguments:

```bash

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

```

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

![install](https://raw.githubusercontent.com/tanhauhau/generator-badge/master/img/screenshot_install.png)

\***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)**

```bash

$ badge installed

```

**List of all badges available**

```bash

$ badge list 

```

You can list all the badges available

```bash

$ badge list

```

![listing](https://raw.githubusercontent.com/tanhauhau/generator-badge/master/img/screenshot_list_all.png)

**List of badges that will be installed**

```bash

$ badge list 

```

Example

```bash 

$ badge list apm tavis

```

![listing](https://raw.githubusercontent.com/tanhauhau/generator-badge/master/img/screenshot_list.png)

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

**Help**

```bash

$ badge help 

```

![help](https://raw.githubusercontent.com/tanhauhau/generator-badge/master/img/screenshot_help.png)

**Clear**

```bash

$ badge clear

```

Remove all badges

## Badges Available

See a list of badges available [here](https://github.com/tanhauhau/generator-badge/blob/master/doc/list.md).

## 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](https://github.com/tanhauhau/generator-badge/blob/master/doc/list.md)

## Badge credits to

[![shields.io](http://shields.io/logo.svg)](http://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