npm package: @shellthor/semantic-demo
Description: demo of the functionality provided by commitizen and semantic-release
Author: Jeff Detmer
Latest version: 1.0.2

<h1 align="center">
  Semantic Demo
</h1>
<p align="center" style="font-size: 1.2rem;">A demo project to show the capabilities of commitizen and semantic-release</p>

<hr />

[![Build Status][build-badge]][build]
[![Code Coverage][coverage-badge]][coverage]
[![Dependencies][dependencyci-badge]][dependencyci]
[![Greenkeeper badge][greenkeeper-badge]][greenkeeper]
[![Sync Vulnerabilities][synk-badge]][synk-project]
[![DeepScan Grade][deepscan-badge]][deepscan]
[![version][version-badge]][package]
[![MIT License][license-badge]][license]

[![All Contributors][contributors]](#contributors)
[![PRs Welcome][prs-badge]][prs]
[![Code of Conduct][coc-badge]][coc]

[![Watch on GitHub][github-watch-badge]][github-watch]
[![Star on GitHub][github-star-badge]][github-star]

## The problem

I needed a project to demo the capabilities of the commitizen and semantic-release tools to my team.

## This solution

This project is setup to use both [Commitizen](https://github.com/commitizen/cz-cli) and [Semantic-Release](https://github.com/semantic-release/semantic-release).

## Table of Contents

<!-- START doctoc generated TOC please keep comment here to allow auto update -->

<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

* [Installation](#installation)
* [Usage](#usage)
* [Contributors](#contributors)
* [License](#license)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Installation

`yarn run setup`

## Usage

`yarn run start`

## Contributors

Thank you for everyone's help! ([emoji key][emojis]):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->

<!-- prettier-ignore -->
| [<img src="https://avatars2.githubusercontent.com/u/649578?v=3" width="100px;"/><br /><sub><b>Jeff Detmer</b></sub>](http://www.jeffdetmer.com)<br />[💻](/shellthor/semantic-demo/commits?author=shellthor "Code") [📖](/shellthor/semantic-demo/commits?author=shellthor "Documentation") [⚠️](/shellthor/semantic-demo/commits?author=shellthor "Tests") [📢](#talk-shellthor "Talks") |
| :---: |

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors][all-contributors] specification. Contributions of any kind welcome!

## License

MIT &copy; Jeff Detmer

[build-badge]: https://img.shields.io/travis/shellthor/semantic-demo.svg?style=flat-square
[build]: https://travis-ci.org/shellthor/semantic-demo
[coverage-badge]: https://img.shields.io/codecov/c/github/shellthor/semantic-demo.svg?style=flat-square
[coverage]: https://codecov.io/github/shellthor/semantic-demo
[dependencyci-badge]: https://dependencyci.com/github/shellthor/semantic-demo/badge
[dependencyci]: https://dependencyci.com/github/shellthor/semantic-demo
[greenkeeper-badge]: https://badges.greenkeeper.io/shellthor/semantic-demo.svg?style=flat-square
[greenkeeper]: https://greenkeeper.io/
[version-badge]: https://img.shields.io/github/tag/shellthor/semantic-demo.svg?style=flat-square
[package]: https://github.com/shellthor/semantic-demo
[license-badge]: https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square
[license]: https://github.com/shellthor/semantic-demo/blob/master/LICENSE.md
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs]: http://makeapullrequest.com
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]: https://github.com/shellthor/restify-boileplate/blob/master/CODE_OF_CONDUCT.md
[github-watch-badge]: https://img.shields.io/github/watchers/shellthor/semantic-demo.svg?style=flat-square
[github-watch]: https://github.com/shellthor/semantic-demo/watchers
[github-star-badge]: https://img.shields.io/github/stars/shellthor/semantic-demo.svg?style=flat-square
[github-star]: https://github.com/shellthor/semantic-demo/stargazers
[emojis]: https://github.com/kentcdodds/all-contributors#emoji-key
[all-contributors]: https://github.com/kentcdodds/all-contributors
[contributors]: https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square
[synk-badge]: https://snyk.io/test/github/shellthor/semantic-demo/badge.svg?style=flat-square
[synk-project]: https://snyk.io/test/github/shellthor/semantic-demo
[deepscan-badge]: https://deepscan.io/api/projects/591/branches/950/badge/grade.svg?style=flat-square
[deepscan]: https://deepscan.io/dashboard/#view=project&pid=591&bid=950