Skip to content

Latest commit

 

History

History
40 lines (22 loc) · 1.51 KB

README.md

File metadata and controls

40 lines (22 loc) · 1.51 KB

Softcover::Sanitizer

Used for displaying user generated content on softcover.io and learnenough.com

Installation

Add this line to your application's Gemfile:

gem 'softcover-sanitizer'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install softcover-sanitizer

Usage

clean_string = Softcover::Sanitizer.clean(dirty_string)

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/softcover/softcover-sanitizer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

Code of Conduct

Everyone interacting in the Softcover::Sanitizer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.