An open API service indexing awesome lists of open source software.

https://github.com/andrewmcodes-archive/gem_template


https://github.com/andrewmcodes-archive/gem_template

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

        

![StandardRB](https://github.com/andrewmcodes/GEM_TEMPLATE/workflows/StandardRB/badge.svg)
![Tests](https://github.com/andrewmcodes/GEM_TEMPLATE/workflows/Tests/badge.svg)

TODO


- [Notice](#notice)
- [Demo](#demo)
- [Installation](#installation)
- [Usage](#usage)
- [Example](#example)
- [Development](#development)
- [Contributing](#contributing)
- [Coding Standards](#coding-standards)
- [Code of Conduct](#code-of-conduct)
- [License](#license)

## Demo

TODO

## Installation

```sh
gem install GEM_TEMPLATE
```

## Usage

TODO

### Example

TODO

## Development

After checking out the repo, run `bin/setup` to install dependencies.

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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/andrewmcodes/GEM_TEMPLATE. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/andrewmcodes/GEM_TEMPLATE/blob/master/CODE_OF_CONDUCT.md).

### Coding Standards

This project uses [Standard](https://github.com/testdouble/standard) to minimize bike shedding related to code formatting.

## Code of Conduct

Everyone interacting in the GEM_TEMPLATE project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/andrewmcodes/GEM_TEMPLATE/blob/master/CODE_OF_CONDUCT.md).

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).