From 93d849d072a29ea13f124975f7b5a0c75b937158 Mon Sep 17 00:00:00 2001 From: Oleg Koval Date: Sun, 3 Nov 2019 17:53:14 +0100 Subject: [PATCH] docs(install): update install notes --- readme.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/readme.md b/readme.md index 3f1dddd..2a63f8e 100644 --- a/readme.md +++ b/readme.md @@ -37,10 +37,30 @@ ## Install +- Install `semantic-release`: + +```sh +npm install --save-dev semantic-release +``` + +- Add `semantic-release` to scripts: + +```json +"scripts": { + ... + "semantic-release": "semantic-release" + ... +} +``` + +- Install `semantic-release-npm-github-publish`: + ```sh npm install --save-dev semantic-release-npm-github-publish ``` +- Add `npx semantic-release` to a "Release" step of your CD setup + ## Usage To use this sharable config, extend your semantic release configuration in `.releaserc.yaml`: