From d29255626566fb1f0229d47cd265aecc1d975d7a Mon Sep 17 00:00:00 2001 From: Brett Uglow Date: Tue, 28 Feb 2017 21:30:28 +1100 Subject: [PATCH] feat(readme): trigger semantic release --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 92da4ef..29e680d 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # upver -> Updates the version number inside a list of files with a supplied version number. +> Updates the version string within a list of files with a new version string. This module can be used with [corp-semantic-release](https://github.com/leonardoanalista/corp-semantic-release) to update the version number in a list of files when the package's version number is changed. See [Usage](#usage) @@ -23,7 +23,7 @@ update the version number in a list of files when the package's version number i ## Install 1. `npm install upver` -2. Create a YAML configuration file with this format (note the use of `<@VERSION@>` to act as the new version placeholder): +2. Create a YAML configuration file with this format (Note the `<@VERSION@>` placeholder for the new version string): ```yaml - file: path/to/file/relative/to/project/root.yml search: Regex search for, e.g.: '"version": (".+")' @@ -64,7 +64,7 @@ In the following example, `upver` does *NOT* receive the version as an argument
-Option 2 - Use with corp-semantic-release +Option 2 - Use with `corp-semantic-release` `corp-semantic-release` provides a `--pre-commit ` option. `upver` is passed the version number as an argument to the script.