From 81fff2741a868f9933a07c029394ff49a633becc Mon Sep 17 00:00:00 2001 From: Adela Homolova <53510747+adelkahomolova@users.noreply.github.com> Date: Fri, 16 Aug 2019 14:06:47 +0200 Subject: [PATCH] fix(README): fix command for installing (#29) * fix(README): fix command for installing, fix: name of contributor feat: add aliases to readme, * fix(README): change the name of command, fix: discard the change of displaying name as it should be generated automatically by .all-contributorsrc --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4a2a8bd05..4ce12add4 100644 --- a/README.md +++ b/README.md @@ -32,27 +32,37 @@ C++ | 🚧 - with NPM - ```npm install -g dxscanner``` + ```npm install -g dx-scanner``` - with Yarn - ```yarn global add dxscanner``` + ```yarn global add dx-scanner``` ### Usage **Scan repository** ``` -dxscanner https://github.com/DXHeroes/dx-scanner +dx-scanner https://github.com/DXHeroes/dx-scanner ``` **Scan local path** ``` -dxscanner ~/my-project +dx-scanner ~/my-project ``` **All options** ``` +dx-scanner [path] +``` + +**Aliases** +``` +dx-scanner [path] + dxscanner [path] + +dxs [path] ``` + ## Contributing 👩‍💻 👨‍💻 Feel free to contribute to the DX Scanner. If you want to contribute, please follow our [Contribution Guide](CONTRIBUTING.md).