README.md.tt - bundler-1.15.4 Documentation

# <%= config %>¶ ↑

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/<%= config[:namespaced_path] %>`. To experiment with that code, run `bin/console` for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

## Installation¶ ↑

Add this line to your application's Gemfile:

    gem '<%= config[:name] %>'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install <%= config[:name] %>

## Usage¶ ↑

TODO: Write usage instructions here

## Development¶ ↑

After checking out the repo, run `bin/setup` to install dependencies.<% if config %> Then, run `rake <%= config[:test].sub('mini', '').sub('rspec', 'spec') %>` to run the tests.<% end %> You can also run `bin/console` for an interactive prompt that will allow you to experiment.<% if config %> Run `bundle exec <%= config[:name] %>` to use the gem in this directory, ignoring other installed copies of this gem.<% end %>

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 github.com/<%= config %>/<%= config %>.<% if config %> This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.<% end %> <% if config -%>

## License¶ ↑

The gem is available as open source under the terms of the MIT License. <% end -%> <% if config -%>

## Code of Conduct¶ ↑

Everyone interacting in the <%= config %> project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](github.com/<%= config %>/<%= config %>/blob/master/CODE_OF_CONDUCT.md). <% end -%>