<%= config.dig(:gem, :label) %>¶ ↑
[ Version(badge.fury.io/rb/<%= config.dig(:gem, :name) %>.svg)](badge.fury.io/rb/<%= config.dig(:gem, :name) %>) <%- if config.dig(:generate, :rubocop) -%>
<%- end -%> <%- if config.dig(:generate, :circle_ci) -%> [
CI Status(circleci.com/gh/<%= config.fetch :github_user %>/<%= config.dig :gem, :name %>.svg?style=svg)](circleci.com/gh/<%= config.fetch :github_user %>/<%= config.dig :gem, :name %>) <%- end -%>
Features¶ ↑
Screencasts¶ ↑
Requirements¶ ↑
-
Ruby <%- if config.dig(:generate, :engine) -%>
-
Ruby on Rails <%- end -%>
Setup¶ ↑
To install, run:
gem install <%= config.dig(:gem, :name) %>
<%- unless config.dig(:generate, :cli) -%> Add the following to your Gemfile:
gem "<%= config.dig(:gem, :name) %>"
<%- end -%>
Usage¶ ↑
Development¶ ↑
To contribute, run:
git clone https://github.com/<%= config.dig(:github_user) %>/<%= config.dig(:gem, :name) %>.git cd <%= config.dig(:gem, :name) %> bin/setup
You can also use the IRB console for direct access to all objects:
bin/console
<%- if config.dig(:generate, :rspec) -%>
Tests¶ ↑
To test, run:
bundle exec rake
<%- end -%>
Versioning¶ ↑
Read Semantic Versioning for details. Briefly, it means:
-
Major (X.y.z) - Incremented for any backwards incompatible public API changes.
-
Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
-
Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
Code of Conduct¶ ↑
Please note that this project is released with a CODE OF CONDUCT. By participating in this project you agree to abide by its terms.
Contributions¶ ↑
Read CONTRIBUTING for details.
License¶ ↑
Copyright <%= config.fetch :year %> [<%= config.dig :organization, :name %>](<%= config.dig :organization, :url %>). Read LICENSE for details.
History¶ ↑
Read CHANGES for details. Built with Gemsmith.
Credits¶ ↑
Developed by [<%= config.dig(:author, :name) %>](<%= config.dig :author, :url %>) at [<%= config.dig :organization, :name %>](<%= config.dig :organization, :url %>).