# martinet [![Gem Version](https://badge.fury.io/rb/martinet.svg)](https://badge.fury.io/rb/martinet) [![Gem](https://img.shields.io/gem/dt/martinet.svg?maxAge=2592000)](https://rubygems.org/gems/martinet) [![Build Status](https://travis-ci.org/TangRufus/martinet.svg?branch=master)](https://travis-ci.org/TangRufus/martinet) [![Dependency Status](https://gemnasium.com/badges/github.com/TangRufus/martinet.svg)](https://gemnasium.com/github.com/TangRufus/martinet) [![Code Climate](https://codeclimate.com/github/TangRufus/martinet/badges/gpa.svg)](https://codeclimate.com/github/TangRufus/martinet) [![Test Coverage](https://codeclimate.com/github/TangRufus/martinet/badges/coverage.svg)](https://codeclimate.com/github/TangRufus/martinet/coverage) [![GitHub issues](https://img.shields.io/github/issues/TangRufus/martinet.svg)](https://github.com/TangRufus/martinet/issues) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/TangRufus/martinet/master/LICENSE.txt) # Table of Contents - [Features](#features) - [Screencasts](#screencasts) - [Requirements](#requirements) - [Setup](#setup) - [Usage](#usage) - [Versioning](#versioning) - [Code of Conduct](#code-of-conduct) - [Contributions](#contributions) - [License](#license) - [History](#history) - [Credits](#credits) # Features # Screencasts # Requirements 0. [MRI 2.3.0](https://www.ruby-lang.org) # Setup For a secure install, type the following (recommended): gem cert --add <(curl --location --silent /gem-public.pem) gem install martinet --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 martinet Add the following to your Gemfile: gem "martinet" # Usage # Versioning Read [Semantic Versioning](http://semver.org) for details. Briefly, it means: - Patch (x.y.Z) - Incremented for small, backwards compatible bug fixes. - Minor (x.Y.z) - Incremented for new, backwards compatible public API enhancements and/or bug fixes. - Major (X.y.z) - Incremented for any backwards incompatible public API changes. # 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) 2016 [](). Read the [LICENSE](LICENSE.md) for details. # History Read the [CHANGELOG](CHANGELOG.md) for details. Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith). # Credits Developed by [Tang Rufus](https://www.github.com/tangrufus) at []().