Skip to content

Commit

Permalink
fix(README): fix command for installing (#29)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
adelkahomolova authored and prokopsimek committed Aug 16, 2019
1 parent 846e58a commit 81fff27
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down

0 comments on commit 81fff27

Please sign in to comment.