# <%= config.dig(:gem, :class) %>

[![Gem Version](https://badge.fury.io/rb/<%= config.dig(:gem, :name) %>.svg)](http://badge.fury.io/rb/<%= config.dig(:gem, :name) %>)
<%- if config.dig(:generate, :code_climate) -%>
[![Code Climate GPA](https://codeclimate.com/github/<%= config.fetch :github_user %>/<%= config.dig(:gem, :name) %>.svg)](https://codeclimate.com/github/<%= config.fetch :github_user %>/<%= config.dig(:gem, :name) %>)
[![Code Climate Coverage](https://codeclimate.com/github/<%= config.fetch :github_user %>/<%= config.dig(:gem, :name) %>/coverage.svg)](https://codeclimate.com/github/<%= config.fetch :github_user %>/<%= config.dig(:gem, :name) %>)
<%- end -%>
<%- if config.dig(:generate, :gemnasium) -%>
[![Gemnasium Status](https://gemnasium.com/<%= config.fetch :github_user %>/<%= config.dig(:gem, :name) %>.svg)](https://gemnasium.com/<%= config.fetch :github_user %>/<%= config.dig(:gem, :name) %>)
<%- end -%>
<%- if config.dig(:generate, :travis) -%>
[![Travis CI Status](https://secure.travis-ci.org/<%= config.fetch :github_user %>/<%= config.dig(:gem, :name) %>.svg)](https://travis-ci.org/<%= config.fetch :github_user %>/<%= config.dig(:gem, :name) %>)
<%- end -%>
<%- if config.dig(:generate, :patreon) -%>
[![Patreon](https://img.shields.io/badge/patreon-donate-brightgreen.svg)](https://www.patreon.com/<%= config.fetch :github_user %>)
<%- end -%>

<!-- Tocer[start]: Auto-generated, don't remove. -->
<!-- Tocer[finish]: Auto-generated, don't remove. -->

# Features

# Screencasts

# Requirements

0. [Ruby <%= config.dig(:versions, :ruby) %>](https://www.ruby-lang.org)
<%- if config.dig(:generate, :rails) -%>
0. [Ruby on Rails](http://rubyonrails.org).
<%- end -%>

# Setup

<%- if config.dig(:generate, :security) -%>
For a secure install, type the following (recommended):

    gem cert --add <(curl --location --silent <%= config.dig :organization, :url %>/gem-public.pem)
    gem install <%= config.dig(:gem, :name) %> --trust-policy MediumSecurity

NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification
while allowing the installation of unsigned dependencies since they are beyond the scope of this
gem.

For an insecure install, type the following (not recommended):

    gem install <%= config.dig(:gem, :name) %>
<%- else -%>
To install, type the following:

    gem install <%= config.dig(:gem, :name) %>
<%- end -%>

<%- unless config.dig(:generate, :cli) -%>
Add the following to your Gemfile:

    gem "<%= config.dig(:gem, :name) %>"
<%- end -%>

# Usage

<%- if config.dig(:generate, :rspec) -%>
# Tests

To test, run:

    bundle exec rake
<%- end -%>

# Versioning

Read [Semantic Versioning](http://semver.org) 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](CODE_OF_CONDUCT.md). By
participating in this project you agree to abide by its terms.

# Contributions

Read [CONTRIBUTING](CONTRIBUTING.md) for details.

# License

Copyright (c) <%= config.fetch :year %> [<%= config.dig :organization, :name %>](<%= config.dig :organization, :url %>).
Read [LICENSE](LICENSE.md) for details.

# History

Read [CHANGES](CHANGES.md) for details.
Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).

# Credits

Developed by [<%= config.dig(:author, :name) %>](<%= config.dig :author, :url %>) at
[<%= config.dig :organization, :name %>](<%= config.dig :organization, :url %>).