From 86605cefdba6ca5d7563a33f96912bf464ef118f Mon Sep 17 00:00:00 2001 From: Denis Smetannikov Date: Tue, 20 Apr 2021 00:00:59 +0300 Subject: [PATCH] Updated Readme --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 34304f4..18e6e5b 100644 --- a/README.md +++ b/README.md @@ -24,9 +24,19 @@ wget https://github.com/JBZoo/Composer-Diff/releases/download//composer ```bash composer update # don't commit yet! -php ./vendor/bin/composer-diff # or just `composer-diff` if installed globally + +# if it's installed via composer +php ./vendor/bin/composer-diff + +# OR (if installed globally) +composer-diff + +# OR (if you downloaded phar file) +php composer-diff.phar ``` + +## Help Description ``` ./vendor/bin/composer-diff --help @@ -173,14 +183,14 @@ Rendered in your readme or PR/MR description: * [ ] Supporting Drupal repos. [For example](https://git.drupalcode.org/project/fast_404). * [ ] Add action in the composer via API like `composer lock-diff`. * [ ] Fixes [the same issue](https://github.com/davidrjonas/composer-lock-diff/issues/26) with complex/custom name of tag. - * [ ] Auto detecting alias name of branch. - * [ ] No warp links for markdown format. + * [ ] Auto-detecting alias name of branch. + * [ ] No warp links for Markdown format. * [ ] (?) Support MS Windows... ## Unit tests and check code style ```sh -make update +make build make test-all ```