Project

svgshield

0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
Simple library for generating SVG status shields
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.13
>= 0
~> 10.0
~> 3.0

Runtime

>= 0
>= 0
 Project Readme

Svgshield

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

hello world

Installation

Add this line to your application's Gemfile:

gem 'svgshield'

And then execute:

$ bundle

Usage

To generate an image XML string:

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.

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.