From d8ab7d9ac15f1465fe2f47468fe9c22f233d9f45 Mon Sep 17 00:00:00 2001 From: Elliott Foster Date: Fri, 17 Feb 2017 16:16:06 -0600 Subject: [PATCH] docs(README): Better description --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cd4c8ed..1d35ffa 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,10 @@ [![Build Status](https://travis-ci.org/elliotttf/semantic-release-conventional-commits.svg?branch=master)](https://travis-ci.org/elliotttf/semantic-release-conventional-commits) [![Coverage Status](https://coveralls.io/repos/github/elliotttf/semantic-release-conventional-commits/badge.svg?branch=master)](https://coveralls.io/github/elliotttf/semantic-release-conventional-commits?branch=master) + This is a [semantic-release](https://www.npmjs.com/package/semantic-release) -plugin used to detect _all_ of the [conventional](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit) commit message styles. +`analyzeCommits` plugin used to detect _all_ of the [conventional](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit) +commit message styles. The commit analyzer that ships with semantic-release only catches `fix` and `feat` commits ([#12](https://github.com/semantic-release/commit-analyzer/issues/12)).