# Badges for Sublime Text

[![The MIT License](https://img.shields.io/badge/license-MIT-orange.svg?style=flat-square)](http://opensource.org/licenses/MIT)
[![Package Control](https://packagecontrol.herokuapp.com/downloads/Badges.svg?style=flat-square)](https://packagecontrol.io/packages/Badges)
[![GitHub release](https://img.shields.io/github/release/idleberg/sublime-badges.svg?style=flat-square)](https://github.com/idleberg/sublime-badges/releases)
[![Travis](https://img.shields.io/travis/idleberg/sublime-badges.svg?style=flat-square)](https://travis-ci.org/idleberg/sublime-badges)

Snippets to quickly insert [Shield.io](http://shields.io) badges into HTML, Markdown, reStructuredText or Textile documents — like those you can see above.

This package is also available for [Atom](https://github.com/idleberg/atom-badges) and [Visual Studio Code](https://github.com/idleberg/vscode-badges).

## Installation

### Package Control

1. Make sure you already have [Package Control](https://packagecontrol.io/) installed
2. Choose *“Install Package”* from the Command Palette (<kbd>Super</kbd>+<kbd>Shift</kbd>+<kbd>p</kbd>)
3. Type *“Badges”* and press <kbd>Enter</kbd>

With [auto_upgrade](http://wbond.net/sublime_packages/package_control/settings/) enabled, Package Control will keep all installed packages up-to-date!

### Manual installation

1. Download the files using the GitHub [.zip](https://github.com/idleberg/sublime-badges/archive/master.zip) download option
2. Unzip the files to your Sublime Text `Packages` directory

## Usage

All snippets start with the prefix `svg-` and is followed by the service you're adressing, with some services offering multiple choices.

Examples:

* `svg-pypi-dl-day` - daily downloads on PyPI
* `svg-pypi-dl-month` - monthly downloads on PyPI
* `svg-travis` - build status on Travis
* `svg-travis-branch` - build status on Travis for a specific branch
* `svg-npm-ver` - the version of a Node package
* `svg-gpl3` - link to GNU General Public License, Version 3

Please refer to the [snippet guide](https://github.com/idleberg/sublime-badges/blob/master/snippets.md) for a complete list.

# License

This work is licensed under the [The MIT License](LICENSE).