Skip to content

Latest commit

 

History

History
35 lines (19 loc) · 1.61 KB

README.md

File metadata and controls

35 lines (19 loc) · 1.61 KB

Streamlined

HTML fragment and component rendering for Ruby using streamlined procs & heredocs with safety checks via RuboCop. Bridgetown, Roda, and Rails all supported.

Installation

Add Streamlined to your application's Gemfile by running:

bundle add streamlined

(If you're using Bridgetown, it's bundled in for Bridgetown 2.0…coming soon)

Usage

Docs forthcoming...

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/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 bin/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/bridgetownrb/streamlined. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

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

Code of Conduct

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