/repo-small-badge

Create badges for repository in ruby.

Primary LanguageRubyMIT LicenseMIT

RepoSmallBadge

Gem Version Build Status Depfu Coverage RubyCritic

RepoSmalladge is a gem that can be added to the Gemfile and consolidates functionality to produce a badge file. The text place and other configurable can be specified at instance time.

Installation

The badge creation is dependent on the Victor gem for creating the SVG formatted badge.

It can be installed in your Ruby library or rails app as part of the Gemfile as follows.

# In your gemfile
gem 'repo-small-badge', :require => false

Usage

Most propably you need a surrounding formatter for a different badge you want to create and this gem is implicitly required.

Examples are:

Configuration Options

The behaviour of RepoSmallBadge can be influenced by configuration options that are passed to the constructor as a hash. The following options are supported:

Development

After checking out the repo, run bundle update to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/marcgrimme/repo-small-badge/fork )
  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. Create a new Pull Request