Sha256: 558b8ed2fae3238d221710ede73ad8d5a967be28026323e2472b1b238a35befa

Contents?: true

Size: 1.26 KB

Versions: 3

Compression:

Stored size: 1.26 KB

Contents

# Svgshield

A very simple library for generating your own SVG status shields. For example:

![hello world](https://img.shields.io/badge/hello-world-blue.svg "hello world")

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'svgshield'
```

And then execute:

    $ bundle

## Usage

To generate an image XML string:

```ruby
redimage1 = Svgshield.new('Subject', 'Status', 'red').to_s # color words
redimage2 = Svgshield.new('Subject', 'Status', '#f00').to_s # hexadecimal colors
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/evertrue/svgshield.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
svgshield-0.1.5 README.md
svgshield-0.1.4 README.md
svgshield-0.1.3 README.md