Skip to content

Yuma-AI/svg_guardian

Repository files navigation

SvgGuardian

Tiny wrapper around svg-hush to sanitize SVGs.

Usage

Add SvgGuardian to your Gemfile:

gem 'svg_guardian'

To sanitize SVG file call #sanitize method:

SvgGuardian.sanitize("your svg file content")

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Yuma-AI/svg_guardian.

License

The gem is available as open source under the terms of the MIT License.