From 0b8f3717047006fe50b5785887a0b5b9bd544e95 Mon Sep 17 00:00:00 2001 From: tallyb Date: Sun, 10 Jun 2018 20:26:43 +0300 Subject: [PATCH] docs(readme): Add usage explanation --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 29f5b6e..62dd4fe 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ [![NPM][npm-nodei-image]][npm-nodei-url] + ## Installation ```bash npm i --save-dev mcfly-semantic-release @@ -19,7 +20,13 @@ In your `package.json` } ``` -Optionnaly additional files or files patterns (globs) can be added to also have their version bumped +Running release will do the following: +- Bumps version. By default, this will publish a patch version, if you want to control the semver option you can pass an optional 'patch', 'minor' or 'major' to the `--type` argument. +- Updates version in files: by default it will only update the root level `package.json`. Optionnaly use `--file` to specify file paths or files patterns (globs) that can have their version updated as well. Files can be `package.json` files or `config.xml` files +- Commit the changed files with a standard commit message. Default message is `chore(app): Version `. Use `--production` to suffix the commit message with the work `production` (can be later used in CI) +- Generates changlog based on Angular standard commit messages. +- Generate a tag with the version number. +- Generates a github release with the version number. ```json "scripts": { @@ -36,8 +43,6 @@ Then, to publish a new version execute the following command: npm run release ``` -By default, this will publish a patch version, if you want to control the semver option you can pass an optional 'patch', 'minor' or 'major' type argument. - **Example :** ```bash