From e0177c25e13812306aab0b0991562d58b6d14767 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Orhun=20Parmaks=C4=B1z?= Date: Mon, 9 Jan 2023 21:06:02 +0300 Subject: [PATCH] docs(readme): update README.md about the NPM package --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9faf168a9b..bbb5b5c097 100644 --- a/README.md +++ b/README.md @@ -126,23 +126,24 @@ pacman -S git-cliff ### From NPM -[git-cliff](https://www.npmjs.com/package/git-cliff) can be installed from NPM: + +You can install and run [git-cliff](https://www.npmjs.com/package/git-cliff) with a single command: ```sh -yarn add -D git-cliff +npx git-cliff@latest ``` -or: +Also, if you want to add `git-cliff` to your project: ```sh +# with yarn +yarn add -D git-cliff + +# with npm npm install git-cliff --save-dev ``` -You can also use `git-cliff` directly with `npx`: - -```sh -npx git-cliff -``` +Afterwards, you can run `git-cliff` via `npm exec git-cliff` or `npx git-cliff@latest`. ### From MacPorts